BthEnterParkMode (Compact 2013)

  • Article

3/26/2014

This function places the Asynchronous Connection-Oriented (ACL) logical transport ACL connection to the peer specified by the Bluetooth address in park state.

Syntax

int BthEnterParkMode(
  BT_ADDR *pba,
  unsigned short beacon_max,
  unsigned short beacon_min,
  unsigned short *pinterval
);

Parameters

  • pba
    [in] Pointer to the Bluetooth address.
  • beacon_max
    [in] The maximum acceptable time between consecutive beacons in Baseband slots (0.625 milliseconds).The value can range from 0x0001 through 0xFFFF and represents 0.625 ms through 40.9 seconds.
  • beacon_min
    [in] The minimum acceptable time between consecutive beacons in Baseband slots (0.625 milliseconds). The value can range from 0x0001 through 0xFFFF and represents 0.625 ms through 40.9 seconds.
  • pinterval
    [out] Pointer to the time between consecutive beacons in Baseband slots (0.625 milliseconds).

Return Value

The following table shows the possible return values.

Value

Description

ERROR_SUCCESS

Success.

ERROR_NOT_FOUND

An active ACL connection to the peer that is specified by the Bluetooth address does not exist.

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 "PARK State" 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 setsockopt function to SO_BTH_ENTER_PARK_MODE.

Requirements

Header

bt_api.h

Library

Btdrt.lib

See Also

Reference

Bluetooth API Management Functions
Bluetooth AG Service Functions
BthExitParkMode