screen_input_guard_event_get_status()

#include <bps/screen_input_guard.h>
 

BPS_API int screen_input_guard_event_get_status(bps_event_t *event)

Since:

BlackBerry 10.2.0

Arguments:

event

The SCREEN_INPUT_GUARD_EVENT_STATUS event to get the screen input guard status from.

Library:

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

Description:

Call the screen_input_guard_event_get_status() function to retrieve the Screen Input Guard status from a SCREEN_INPUT_GUARD_EVENT_STATUS event. SCREEN_INPUT_GUARD_EVENT_STATUS events are delivered only while Screen Input Guard is enabled via screen_input_guard_enable().

Returns:

The Screen Input Guard status as one of the values of the screen_input_guard_status_t enumeration or BPS_FAILURE on error.