navigator_invoke_query_set_action()

Set the action of a query.

Synopsis:

#include <bps/navigator_invoke.h>
 
BPS_API int navigator_invoke_query_set_action(navigator_invoke_query_t *query,
                                              const char *action)

Since:

BlackBerry 10.0.0

Arguments:

query

A pointer to the navigator_invoke_query_t structure whose action member you want to set.

action

The action you want to query for. The value must conform to the "[Domain][Sub-domain]" format (see description for further information).

Library:

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

Description:

The navigator_invoke_query_set_action() function sets the action member of a given navigator_invoke_query_t structure. The action member identifies the action the invocation query results must be able to perform.

If you don't assign an action member to an invocation query, the brokering system doesn't filter for any specific action.

The format of an action member must conform to the following guidelines:
  • Maximum 50 characters
  • Action: [Domain][Sub-domain]
  • Sub-domain: NUL | .[Domain][Sub-domain]
  • Domain: [a-zA-Z]([a-zA-Z0-9_])*

Example: "bb.action.SHARE"

Returns:

BPS_SUCCESS upon success, BPS_FAILURE with errno set otherwise.