BluetoothSendAuthenticationResponseEx function (Windows)

Switch View :

ScriptFree

BluetoothSendAuthenticationResponseEx function

Applies to: desktop apps only

The BluetoothSendAuthenticationResponseEx function is called when an authentication request to send the passkey or a Numeric Comparison response is made.

Note This API is supported in Windows Vista SP2 and Windows 7.

Syntax

HRESULT WINAPI BluetoothSendAuthenticationResponseEx(
  __in_opt  HANDLE hRadioIn,
  __in      PBLUETOOTH_AUTHENTICATE_RESPONSE pauthResponse
);

Parameters

hRadioIn [in, optional]: A handle of the Bluetooth radio device to specify local service information for.
pauthResponse [in]: Pointer to a BLUETOOTH_AUTHENTICATE_RESPONSE structure containing the response to the BTH_REMOTE_AUTHENTICATE_REQUEST event.

Return value

Returns ERROR_SUCCESS upon successful completion; returns the following error codes upon failure:

Return code	Description
ERROR_CANCELLED	The device was denied the passkey response. This may also indicate a communications problem with the local radio device.
E_FAIL	The device returned a failure code during authentication.

Remarks

Callers can only use this function to respond to a pending authentication request. Applications should register with BluetoothRegisterForAuthenticationEx in order to be notified of incoming authentication requests.

Only the BLUETOOTH_AUTHENTICATION_METHOD_LEGACY, BLUETOOTH_AUTHENTICATION_METHOD_NUMERIC_COMPARISON and BLUETOOTH_AUTHENTICATION_METHOD_PASSKEY_NOTIFICATION response types are valid.

Requirements

Minimum supported client	Windows Vista, Windows XP with SP2
Minimum supported server	None supported
Header	BluetoothAPIs.h (include Bthsdpdef.h or BluetoothAPIs.h)
Library	Bthprops.lib