BthWriteScanEnableMask (Compact 2013)

  • Article

3/26/2014

This function sets the scan mode for the controller.

Syntax

int BthWriteScanEnableMask(
  unsigned char mask
);

Parameters

  • mask
    [in] Sets the scan mode.

    The following table shows the values that are used for the mask.

    Value

    Definition

    0x00

    No scans are enabled.

    0x01

    Inquiry scan is enabled and page scan is disabled.

    0x02

    Inquiry scan disabled and page scan is enabled.

    0x03

    Inquiry scan 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

The change to the mode is not persistent. It reverts to the default setting when the controller is reinitialized; for example, when the controller is reinserted or the device is powered down.

For more information, see "Write Scan Enable" in the Core Specification v2.1 + EDR on the Bluetooth web site.

Note

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

Requirements

Header

bt_api.h

Library

Btdrt.lib

See Also

Reference

Bluetooth API Management Functions
Bluetooth AG Service Functions