BthSSPPairRequest (Compact 7)

  • Article

3/12/2014

This function starts the process of pairing with the specified remote Bluetooth device.

Syntax

DWORD BthSSPPairRequest(
    __in const BT_ADDR *RemoteDevice
);

Parameters

  • RemoteDevice
    [in] Pointer to the address of the remote device with which to start pairing.

Return Value

The following table shows the possible return values.

Value Description

ERROR_SUCCESS

Success.

ERROR_SERVICE_NOT_ACTIVE

The Bluetooth stack is not present.

Remarks

The application must call BthSSPSetConfigurationInfo before it calls this function.

Before the local application can receive the BTE_CLASS_SSP events that the pairing process generates, it must register a message queue using the RequestBluetoothNotifications function.

Depending on the declared capabilities of the local and remote devices, the pairing that occurs because of calling this function might be either Secure Simple Pairing or legacy PIN pairing.

Requirements

Header

bt_api.h

Library

Btdrt.lib

See Also

Reference

Bluetooth API SSP Functions
BthSSPUserConfirmationRequestReply