BthSSPUserConfirmationRequestReply (Compact 7)

  • Article

3/12/2014

This function indicates whether the user observed matching passkeys on both Bluetooth devices being paired.

Syntax

DWORD BthSSPUserConfirmationRequestReply(
    __in const BT_ADDR *RemoteDevice,
    BOOL                UserAccepted
);

Parameters

  • RemoteDevice
    [in] Pointer to the address of the remote device being paired.

  • UserAccepted
    Set to TRUE if the user observed matching passkeys on the two Bluetooth devices being paired.

    Otherwise, set to FALSE.

Return Value

The following table shows the possible return values.

Value Description

ERROR_SUCCESS

Success.

ERROR_INVALID_PARAMETER

The address of the remote device passed in RemoteDevice was invalid.

ERROR_OUTOFMEMORY

The Bluetooth subsystem could not allocate sufficient memory to complete the call.

Remarks

When the local application receives a BTE_SSP_USER_CONFIRMATION_REQUEST event, it displays the provided passkey (six decimal digits) to the user. The Bluetooth peer device also displays a passkey. The user must either accept the passkeys as matching, which indicates that pairing should continue, or reject them as non-matching, which indicates that pairing should not continue. The mechanism through which the user indicates a passkey match or mismatch is device-dependent. For example, the application might present a screen with Accept and Reject soft keys. In any case, the application informs the Bluetooth stack of the user’s observation via the UserAccepted parameter of this function.

The application may confirm automatically without asking the user by calling this function and passing TRUE as the UserAccepted parameter under either of the following circumstances:

  • The application is not capable of asking the user for confirmation.
  • The application initiated pairing by calling BthSSPPairRequest, and is using security level 0-2.

Requirements

Header

bt_api.h

Library

Btdrt.lib

See Also

Reference

Bluetooth API SSP Functions
BT_SSP_USER_CONFIRMATION_REQUEST_EVENT
BthSSPAbortPairing