screen_event_get_event()

Get the libscreen event from a BPS event.

Synopsis:

#include <bps/screen.h>
 
BPS_API screen_event_t screen_event_get_event(bps_event_t *event)

Since:

BlackBerry 10.0.0

Arguments:

event

The event to extract the libscreen screen_event_t from.

Library:

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

Description:

The screen_event_get_event() function extracts the libscreen screen_event_t that is stored within a BPS event. Note that the screen_event_t is valid for the same period as the bps_event_t; that is, until bps_get_event() is called again. An application must not call screen_destroy_event() on the screen_event_t that is extracted from the BPS event.

The domain of the event must be the same as the domain that is returned from screen_get_domain(), and the code of the event must be BPS_SCREEN_EVENT.

Returns:

The libscreen screen_event_t.