navigator_invoke_invocation_get_file_transfer_mode()

Get the file transfer mode of an invocation.

Synopsis:

#include <bps/navigator_invoke.h>
 
BPS_API int navigator_invoke_invocation_get_file_transfer_mode(const navigator_invoke_invocation_t *invoke)

Since:

BlackBerry 10.0.0

Arguments:

invoke

A pointer to the navigator_invoke_invocation_t structure whose transfer mode 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_file_transfer_mode() function extracts the navigator_invoke_file_transfer_mode_t file transfer mode of a given navigator_invoke_invocation_t structure.

The transfer mode member is used to control how files are passed between sender and target (see the navigator_invoke_invocation_set_file_transfer_mode() function for further details).

Returns:

The file transfer mode that describes how the file will be transfered in the case that it points to a file URI that is not in the shared area, or BPS_FAILURE with errno set if an error occurs.