navigator_invoke_viewer_get_invocation()

#include <bps/navigator_invoke.h>
 

BPS_API const navigator_invoke_invocation_t* navigator_invoke_viewer_get_invocation(const navigator_invoke_viewer_t *viewer) BPS_DEPRECATED

Since:

BlackBerry 10.0.0

Arguments:

viewer

The navigator_invoke_viewer_t structure to extract the navigator_invoke_invocation_t structure from.

Library:

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

Description:

Deprecated:

The use of viewers has been deprecated - use applications or cards as invocation targets instead.

The navigator_invoke_viewer_get_invocation() function extracts a pointer to the navigator_invoke_invocation_t structure that has been assigned to the given navigator_invoke_viewer_t structure. This can be used to retrieve invocation members assigned to a given viewer. For example, call this function from the event handler upon calling the navigator_invoke_event_get_viewer() function to extract the invocation properties of the viewer (see the navigator_invoke_invocation_set_*() functions for further details about the navigator_invoke_invocation_t structure parameters).

If you retrieved the given viewer using the navigator_invoke_event_get_viewer() function, the pointer to the navigator_invoke_viewer_t structure remains valid until the bps_get_event() function is called again. If you created the viewer using navigator_invoke_viewer_create(), the pointer will be valid until the navigator_invoke_viewer_destroy() function is called.

Note that "ownership" of the invocation is not passed to the handler. For this reason, don't call the navigator_invoke_invocation_destroy() function on navigator_invoke_invocation_t structures that are retrieved using this function.

Returns:

A pointer to the navigator_invoke_invocation_t structure upon success, NULL with errno set otherwise.