menu_invocation_get_file_transfer_mode()

Retrieve the transfer mode of the menu invocation object.

Synopsis:

#include "bps/menu.h"
 
BPS_API int menu_invocation_get_file_transfer_mode(menu_invocation_t *invocation)

Since:

BlackBerry 10.0.0

Arguments:

invocation

The menu invocation to retrieve the data from.

Library:

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

Description:

The menu_invocation_get_file_transfer_mode() function extracts the file transfer mode (navigator_invoke_file_transfer_mode_t) of the given menu invocation object. The allowable return values are:

  • NAVIGATOR_INVOKE_FILE_TRANSFER_MODE_UNSPECIFIED
  • NAVIGATOR_INVOKE_FILE_TRANSFER_MODE_PRESERVE
  • NAVIGATOR_INVOKE_FILE_TRANSFER_MODE_COPY_RO
  • NAVIGATOR_INVOKE_FILE_TRANSFER_MODE_COPY_RW
  • NAVIGATOR_INVOKE_FILE_TRANSFER_MODE_LINK

Returns:

The menu request file transfer mode if provided by the sender, NAVIGATOR_INVOKE_FILE_TRANSFER_MODE_UNSPECIFIED otherwise, BPS_FAILURE with errno set if an error occurs.