navigator_event_get_syskey_id()

Get the system key id from a navigator system key event.

Synopsis:

#include <bps/navigator.h>
 
BPS_API const char* navigator_event_get_syskey_id(bps_event_t *event)

Since:

BlackBerry 10.3.1

Arguments:

event

The NAVIGATOR_SYSKEY_PRESS event to extract the system key id from.

Library:

libbps (For the qcc command, use the -l bps option to link against this library)

Description:

The navigator_event_get_syskey_id() function extracts the id from a NAVIGATOR_SYSKEY_PRESS event. This is the id that should be passed into navigator_syskey_press_response() which should be called as soon as possible after receiving the NAVIGATOR_SYSKEY_PRESS event. This function does not copy data and the returned value is released once the bps_get_event() function is called again.

Returns:

The system key id from the event. Otherwise, return NULL with errno set.