BthReadLinkPolicySettings

Other versions of this page are also available for the following:

Windows Mobile Not SupportedWindows Embedded CE Supported

8/28/2008

This function reads the current link policy for the existing connection with the peer specified by its Bluetooth address.

Note

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

Syntax

int BthReadLinkPolicySettings(
  BT_ADDR* pba,
  unsigned short* plps
);

Parameters

  • pba
    [in] Pointer to the Bluetooth address.
  • plps
    [in] Pointer to the link policy for the existing connection.

    The following table shows the flags that can be used in combination.

    Flag Description

    0x0000

    Disables all LAN Manager (LM) modes.

    0x0001

    Enables the master slave switch.

    0x0002

    Enables Hold mode.

    0x0004

    Enables Sniff Mode.

    0x0008

    Enables Park 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 more information about this function, see the Read_Link_Policy_Settings 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