BT_SSP_KEYPRESS_NOTIFICATION_EVENT (Compact 2013)

3/26/2014

This structure contains event data for the BT_SSP_KEYPRESS_NOTIFICATION event.

Syntax

typedef struct BT_SSP_KEYPRESS_NOTIFICATION_EVENT {
    BTSSP_Keypress_Notification_Type Type;
} BT_SSP_KEYPRESS_NOTIFICATION_EVENT;

Members

• Type
  Kind of keystroke event being reported from the remote device. For values see BTSSP_Keypress_Notification_Type.

Remarks

If the application is displaying a passkey that the user is entering into the remote device, the application may stop displaying the passkey upon receiving this event with a Type value of BTSSP_Keypress_Notification_Completed.

This structure is the KeypressNotification member of the BTSSPEvent structure. It is present in the union in BTSSPEvent when BTSSPEvent.BTECode is set to BTE_SSP_KEYPRESS_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_KEYPRESS_NOTIFICATION);
BTSSPEvent *pSSPEventData = (BTSSPEvent *) event.baEventData;
BT_SSP_KEYPRESS_NOTIFICATION_EVENT keypressEventData =
  pSSPEventData->KeypressNotification;

Requirements

Header

bt_api.h

See Also

Reference

Bluetooth Application Development Structures
RequestBluetoothNotifications
StopBluetoothNotifications
Bluetooth Application Development Events