menu_request_set_metadata()

Set the metadata of a menu request.

Synopsis:

#include "bps/menu.h"

BPS_API int menu_request_set_metadata(menu_request_t *request,
                                      const char *metadata)

Since:

BlackBerry 10.0.0

Arguments:

request: The menu request to update.

metadata: The metadata to set.

Library:

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

Description:

The menu_request_set_metadata() function sets the metadata of the specified menu request. The menu_request_set_metadata() function sets the metadata of the specified menu request. The menu service correlates the metadata with the invoke target information it receives so that the target invocation, including the associated metadata, can be made if the menu item is selected.

Returns:

BPS_SUCCESS upon success, BPS_FAILURE with errno set otherwise.