navigator_window_cover_attribute_set_file()

Set the window cover image using a file.

Synopsis:

#include <bps/navigator.h>

BPS_API int navigator_window_cover_attribute_set_file(navigator_window_cover_attribute_t *attribute,
                                                      const char *file)

Since:

BlackBerry 10.0.0

Arguments:

attribute: The window cover attribute handle.

file: Path to an image file that will be used as the cover.

Library:

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

Description:

There are 4 modes for covers: live, file, capture, or alternate window. If an image file is being used, live and capture will be disabled.

Returns:

On success return BPS_SUCCESS. Otherwise, return BPS_FAILURE with errno set, the file will not be changed.