navigator_invoke_invocation_get_id()

Get the ID from an invocation.

Synopsis:

#include <bps/navigator_invoke.h>
 
BPS_API const char* navigator_invoke_invocation_get_id(const navigator_invoke_invocation_t *invocation)

Since:

BlackBerry 10.0.0

Arguments:

invocation

A pointer to the navigator_invoke_invocation_t structure whose id member you want to retrieve.

Library:

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

Description:

The navigator_invoke_invocation_get_id() function extracts the invocation ID of a given navigator_invoke_invocation_t structure. The id member is used by the invocation handler to create delivery receipt responses to be returned when an invocation is sent (see the navigator_invoke_invocation_set_id() function for further details). This function doesn't copy members and the returned values are released once the navigator_invoke_invocation_t structure is destroyed with the navigator_invoke_invocation_destroy() function.

Returns:

The invocation ID if one was provided by the sender, NULL otherwise.