BTSSPEvent (Compact 2013)

3/26/2014

This structure contains the data associated with Bluetooth Secure Simple Pairing (SSP) events.

Syntax

typedef struct BTSSPEvent {
    DWORD                dwSize;
    BT_ADDR              RemoteDevice;
    ULONG                BTECode;
    union {
        BT_SSP_USER_CONFIRMATION_REQUEST_EVENT  UserConfirmationRequest;
        BT_SSP_PASSKEY_REQUEST_EVENT            PasskeyRequest;
        BT_SSP_PAIRING_COMPLETE_EVENT           PairingComplete;
        BT_SSP_USER_PASSKEY_NOTIFICATION_EVENT  UserPasskeyNotification;
        BT_SSP_KEYPRESS_NOTIFICATION_EVENT      KeypressNotification;
        BT_SSP_IO_CAPABILITY_REQUEST_EVENT      IoCapabilityRequest;
        BT_SSP_IO_CAPABILITY_RESPONSE_EVENT     IoCapabilityResponse;
        BT_SSP_REMOTE_OOB_DATA_REQUEST_EVENT    RemoteOOBDataRequest;
        BT_SSP_PIN_CODE_REQUEST_EVENT           PINCodeRequest;
        BT_SSP_IO_CAPABILITY_NOTIFICATION_EVENT IoCapabilityNotification;
        BT_SSP_AUTHENTICATION_COMPLETED_EVENT   AuthenticationCompleted;
    };
} BTSSPEvent;

Members

• dwSize
  Size of this structure.

• RemoteDevice
  Address of the remote Bluetooth device as a BT_ADDR type.

• BTECode
  Identifies the type of the associated SSP event and the structure within the union that follows. One of the event identifiers listed below with the associated structures. All such events are in the BTE_CLASS_SSP event class.

• UserConfirmationRequest
  Structure of type BT_SSP_USER_CONFIRMATION_REQUEST_EVENT that is present when the BTECode member is set to BTE_SSP_USER_CONFIRMATION_REQUEST.

• PasskeyRequest
  Structure of type BT_SSP_PASSKEY_REQUEST_EVENT that is present when the BTECode member is set to BTE_SSP_USER_PASSKEY_REQUEST.

• PairingComplete
  Structure of type BT_SSP_PAIRING_COMPLETE_EVENT that is present when the BTECode member is set to BTE_SSP_PAIRING_COMPLETE.

• UserPasskeyNotification
  Structure of type BT_SSP_USER_PASSKEY_NOTIFICATION_EVENT that is present when the BTECode member is set to BTE_SSP_USER_PASSKEY_NOTIFICATION.

• KeypressNotification
  Structure of type BT_SSP_KEYPRESS_NOTIFICATION_EVENT that is present when the BTECode member is set to BTE_SSP_KEYPRESS_NOTIFICATION.

• IoCapabilityRequest
  Structure of type BT_SSP_IO_CAPABILITY_REQUEST_EVENT that is present when the BTECode member is set to BTE_SSP_IO_CAPABILITY_REQUEST.

• IoCapabilityResponse
  Structure of type BT_SSP_IO_CAPABILITY_RESPONSE_EVENT that is present when the BTECode member is set to BTE_SSP_IO_CAPABILITY_RESPONSE.

• RemoteOOBDataRequest
  Structure of type BT_SSP_REMOTE_OOB_DATA_REQUEST_EVENT that is present when the BTECode member is set to BTE_SSP_IO_CAPABILITY_REQUEST.

• PINCodeRequest
  Structure of type BT_SSP_PIN_CODE_REQUEST_EVENT that is present when the BTECode member is set to BTE_SSP_PIN_CODE_REQUEST.

• IoCapabilityNotification
  Structure of type BT_SSP_IO_CAPABILITY_NOTIFICATION_EVENT that is present when the BTECode member is set to BTE_SSP_IO_CAPABILITY_NOTIFICATION.

• AuthenticationCompleted
  Structure of type BT_SSP_AUTHENTICATION_COMPLETED_EVENT that is present when the BTECode member is set to BTE_SSP_AUTHENTICATION_COMPLETED.

Remarks

This structure contains the event data for BTE_CLASS_SSP events. It is used as the baEventData member of BTEVENT structures associated with BTE_CLASS_SSP events. The BTEVENT's dwEventId field and the BTSSPEvent’s BTECode field both contain the same event code.

Requirements

Header

bt_api.h

See Also

Reference

Bluetooth Application Development Structures
RequestBluetoothNotifications
StopBluetoothNotifications
Bluetooth Application Development Events