mmr_event_get()

Get the next available event.

Synopsis:

#include <mm/renderer/events.h>
 
const mmr_event_t* mmr_event_get(mmr_context_t *ctxt)

Since:

BlackBerry 10.0.0

Arguments:

ctxt

A context handle.

Library:

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

Description:

Get the next available event. The function returns a pointer to an mmr_event_t structure, which contains detailed event information such as the new context state (see mmr_event_t for details). Typically, you would call this function within an event-processing loop, after calling either mmr_event_arm() or mmr_event_wait().

The data returned in the mmr_event_t structure is valid only until the next mmr_event_get() call. If you want to keep the data longer, copy the mmr_event_t contents into other program variables, cloning any strm_string_t fields within the structure.

Returns:

A pointer to an event, or NULL on error (check errno).