menu_request_set_data()

Set the data of a menu request.

Synopsis:

#include "bps/menu.h"
 
BPS_API int menu_request_set_data(menu_request_t *request,
                                  const void *data,
                                  int data_length)

Since:

BlackBerry 10.0.0

Arguments:

request

The menu request to update.

data

The data to set. Omitting the data implies that the action-type is sufficient to carry out the invocation. Base64 encoding of binary data is not necessary as encoding is done for you.

data_length

The size of the data member in bytes.

Library:

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

Description:

The menu_request_set_data() function sets the data of the specified menu request. The menu_request_set_data() function sets the data and data length of the specified menu request. The menu service correlates the data with the invoke target information it receives so that the target invocation, including the data to be acted upon, can be made if the menu item is selected. Omitting the data implies that the action and type are sufficient to carry out the invocation. The value of the data member can take the form of any binary data.

Returns:

BPS_SUCCESS upon success, BPS_FAILURE with errno set otherwise.