Share via

BTSSP_Keypress_Notification_Type (Compact 2013)

  • Article

3/26/2014

This enumeration lists the actions that the user can take while entering a passkey.

Syntax

typedef enum  BTSSP_Keypress_Notification_Type{
  BTSSP_Keypress_Notification_Started,
  BTSSP_Keypress_Notification_Digit_Entered,
  BTSSP_Keypress_Notification_Digit_Erased,
  BTSSP_Keypress_Notification_Cleared,
  BTSSP_Keypress_Notification_Completed
} BTSSP_Keypress_Notification_Type;

Elements

  • BTSSP_Keypress_Notification_Started
    Indicates that the user started entering the requested passkey.
  • BTSSP_Keypress_Notification_Digit_Entered
    Indicates that the user entered another digit of the passkey.
  • BTSSP_Keypress_Notification_Digit_Erased
    Indicates that the user backspaced over a previously provided passkey digit.
  • BTSSP_Keypress_Notification_Cleared
    Indicates that the user cleared the entire passkey entered so far.
  • BTSSP_Keypress_Notification_Completed
    Indicates that the user completed entering the passkey.

Remarks

After an application receives a BTE_SSP_USER_PASSKEY_REQUEST event, and prior to the application calling BthSSPUserPasskeyRequestReply, the application may indicate passkey entry progress by calling BthSSPSendKeypressNotification one or more times using one of these enumeration values to represent the nature of the progress. The peer application receives corresponding BTE_SSP_KEYPRESS_NOTIFICATION events.

Note

Keypress notifications are optional; successful pairing may occur without them.

Requirements

Header

bt_api.h

See Also

Reference

Bluetooth Application Development Enumerations
BT_SSP_KEYPRESS_NOTIFICATION_EVENT