BthReadScanEnableMask (Compact 2013)

  • Article

3/26/2014

This function reads the scan mode of the controller.

Syntax

int BthReadScanEnableMask(
  unsigned char *pmask
);

Parameters

  • pmask
    [in] Pointer to the scan mode.

    The following table shows the possible scan mode values.

    Value

    Definition

    0x00

    No scans are enabled.

    0x01

    Inquiry scan is enabled and page scan is disabled.

    0x02

    Inquiry scan is disabled and page scan is enabled.

    0x03

    Inquiry scan is enabled and page scan is enabled.

Return Value

The following table shows the possible return values.

Value

Description

ERROR_SUCCESS

Success.

ERROR_SERVICE_NOT_ACTIVE

The Bluetooth stack is not present.

Other standard HRESULT error codes may be returned as appropriate.

Remarks

For more information, see "Read Scan Enable" in the Core Specification v2.1 + EDR on the Bluetooth website.

Note

To preserve Microsoft Win32 compatibility, consider using the Winsock equivalent of this function. To do so, set the optname parameter in the getsockopt function to SO_BTH_GET_SCAN.

Requirements

Header

bt_api.h

Library

Btdrt.lib

See Also

Reference

Bluetooth API Management Functions
Bluetooth AG Service Functions