Edit

Share via

BLUETOOTH_AUTHENTICATE_RESPONSE structure (bluetoothapis.h)

  • Article

The BLUETOOTH_AUTHENTICATE_RESPONSE structure contains information passed in response to a BTH_REMOTE_AUTHENTICATE_REQUEST event.

Syntax

typedef struct _BLUETOOTH_AUTHENTICATE_RESPONSE {
  BLUETOOTH_ADDRESS               bthAddressRemote;
  BLUETOOTH_AUTHENTICATION_METHOD authMethod;
  union {
    BLUETOOTH_PIN_INFO                pinInfo;
    BLUETOOTH_OOB_DATA_INFO           oobInfo;
    BLUETOOTH_NUMERIC_COMPARISON_INFO numericCompInfo;
    BLUETOOTH_PASSKEY_INFO            passkeyInfo;
  };
  UCHAR                           negativeResponse;
} BLUETOOTH_AUTHENTICATE_RESPONSE, *PBLUETOOTH_AUTHENTICATE_RESPONSE;

Members

bthAddressRemote

A BLUETOOTH_ADDRESS structure that contains the address of the device requesting the authentication response.

Note  This information can be found in the PBLUETOOTH_AUTHENTICATION_CALLBACK PARAMS structure retrieved from the callback.
 

authMethod

A BLUETOOTH_AUTHENTICATION_METHOD enumeration that defines the supported authentication method.

Note  This information can be found in the PBLUETOOTH_AUTHENTICATION_CALLBACK PARAMS structure retrieved from the callback.
 

pinInfo

One of the following structures must be used according to the authentication method defined in authMethod. For example, if BLUETOOTH_AUTHENTICATION_METHOD_LEGACY is specified, the BLUETOOTH_PIN_INFO structure must be populated.

Contains information for pin authentication.

oobInfo

Contains out-of-band data used to authenticate the device.

numericCompInfo

Contains information for numeric comparison authentication.

passkeyInfo

Contains information for passkey authentication.

negativeResponse

TRUE if the authentication request was rejected; otherwise FALSE.

Requirements

Requirement Value
Minimum supported client Windows XP with SP2 [desktop apps only]
Minimum supported server None supported
Header bluetoothapis.h (include Bthsdpdef.h, BluetoothAPIs.h)

See also

BLUETOOTH_AUTHENTICATION_METHOD