BthEnterHoldMode (Compact 2013)

  • Article

3/26/2014

This function places the Asynchronous Connection-Oriented logical transport (ACL) connection to the peer in hold mode.

Syntax

int BthEnterHoldMode(
  BT_ADDR *pba,
  unsigned short hold_mode_max,
  unsigned short hold_mode_min,
  unsigned short *pinterval
);

Parameters

  • pba
    [in] Pointer to the Bluetooth address of the peer.
  • hold_mode_max
    [in] The maximum acceptable time to be in hold mode in Baseband slots (0.625 milliseconds). The value can range from 0x0001 through 0xFFFF and represents 0.625 ms through 40.9 seconds.
  • hold_mode_min
    [in] The minimum acceptable time to be in hold mode 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] The time to be in hold mode 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 connection to the specified peer device 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 "Hold Mode" 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_HOLD_MODE.

Requirements

Header

bt_api.h

Library

Btdrt.lib

See Also

Reference

Bluetooth API Management Functions
Bluetooth AG Service Functions