Share via

BT_SSP_IO_CAPABILITY_NOTIFICATION_EVENT (Compact 2013)

  • Article

3/26/2014

This structure contains event data for the BT_SSP_IO_CAPABILITY_NOTIFICATION event.

Syntax

typedef struct BT_SSP_IO_CAPABILITY_NOTIFICATION_EVENT {
    BTSSPIOCapability    IOCapability;
    BOOL                 OOBDataPresent;
    BTSSPAuthRequirement AuthRequirement;
} BT_SSP_IO_CAPABILITY_NOTIFICATION_EVENT;

Members

  • IOCapability
    Indicates the input/output capabilities registered with the Bluetooth stack for the local device. For values see BTSSPIOCapability.
  • OOBDataPresent
    TRUE if out-of-band (OOB) data has been registered with the Bluetooth stack.
  • AuthRequirement
    Authentication requirements for this pairing. For details see BTSSPAuthRequirement.

Remarks

This event indicates how the local Bluetooth stack is responding to an I/O capability request from a Bluetooth peer. The event associated with this structure, BTE_SSP_IO_CAPABILITY_NOTIFICATION, is informative only; no action is required from the application upon reception of this event. The data in this structure indicates the values sent by the Bluetooth stack to the baseband in response to an HCI I/O Capability Request event.

Together with the I/O capability data that the BTE_SSP_IO_CAPABILITY_RESPONSE event provides, you can use the data in this structure to determine whether the Just Works SSP procedure is in progress.

This structure is the IOCapabilityNotification member of the BTSSPEvent structure. It is present in the union in BTSSPEvent when BTSSPEvent.BTECode is set to BTE_SSP_IO_CAPABILITY_NOTIFICATION.

Example

The following code shows how to access this structure.

Important

For readability, the following code example does not contain security checking or error handling. Do not use the following code in a production environment.

BTEVENT event;
// Insert code to retrieve event from message queue.
ASSERT(event.dwEventId == BTE_SSP_IO_CAPABILITY_NOTIFICATION);
BTSSPEvent *pSSPEventData = (BTSSPEvent *) event.baEventData;
BT_SSP_IO_CAPABILITY_NOTIFICATION_EVENT ioNotifEventData =
  pSSPEventData->IOCapabilityNotification;

Requirements

Header

bt_api.h

See Also

Reference

Bluetooth Application Development Structures
RequestBluetoothNotifications
StopBluetoothNotifications
Bluetooth Application Development Events