Share via

BthEnterHoldMode

  • Article

This function places the ACL connection to the peer in HOLD mode.

Note   To preserve Win32 compatibility, consider using the Winsock equivalent of this function. To do so, pass SO_BTH_ENTER_HOLD_MODE as the optname value in setsockopt.

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 number of Baseband slots to be in Hold Mode.
  • hold_mode_min
    [in] Minimum acceptable number of Baseband slots to be in Hold Mode.
  • pinterval
    [out] The number of Baseband slots to be in Hold Mode.

Return Values

This function returns ERROR_SUCCESS when it completes successfully.

A return value of ERROR_SERVICE_NOT_ACTIVE indicates that the hardware is not inserted or that the Bluetooth stack is not present.

A return value of ERROR_NOT_FOUND indicates that an active ACL connection to the peer that is specified by the Bluetooth address does not exist.

Other standard error codes may be returned as appropriate.

Remarks

For the timing parameters, the time length is equal to = N * 0.625 msec, or 1 Baseband slot. The valid time range is 0.625 msec to 40.9 Seconds. The valid range for N is is 0x0001 to 0xFFFF.

For more information about this function, see the Hold_Mode part of the Bluetooth Core Specification.

Requirements

OS Versions: Windows CE .NET 4.2 and later.
Header: Bt_api.h.
Link Library: Btdrt.lib.

See Also

Bluetooth Platform Development Functions | Bluetooth

Last updated on Wednesday, April 13, 2005

© 2005 Microsoft Corporation. All rights reserved.