Partager via


BthEnterHoldMode (Windows Embedded CE 6.0)

1/6/2010

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.

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 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 Value

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 0x0001 to 0xFFFF.

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

Requirements

Header bt_api.h
Library Btdrt.lib
Windows Embedded CE Windows CE .NET 4.2 and later

See Also

Reference

Bluetooth OS Functions

Other Resources

Bluetooth Application Development