Share via

BthSSPUserPasskeyRequestReply (Compact 2013)

  • Article

3/26/2014

This function is called by the local application to provide the passkey that the user entered, if available.

Syntax

DWORD BthSSPUserPasskeyRequestReply(
    const BT_ADDR *RemoteDevice,
    BOOL           HavePasskey,
    UINT           Passkey
);

Parameters

  • RemoteDevice
    [in] Pointer to the address of the remote device being paired.
  • HavePasskey
    [in] Set to TRUE if the Passkey parameter contains a passkey; otherwise, FALSE.
  • Passkey
    [in] If HavePasskey is TRUE, this parameter is the numeric value of the passkey. If HavePasskey is FALSE, this parameter is ignored.

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 calls this function to send the passkey information to the remote Bluetooth device in response to a BTE_SSP_USER_PASSKEY_REQUEST event.

The application may optionally call BthSSPSendKeypressNotification during passkey entry to keep the remote Bluetooth device informed about the passkey entry progress.

Requirements

Header

bt_api.h

Library

Btdrt.lib

See Also

Reference

Bluetooth API SSP Functions
BT_SSP_PASSKEY_REQUEST_EVENT
BthSSPAbortPairing