navigator_window_cover_attribute_set_capture()

Set the window cover capture size.

Synopsis:

#include <bps/navigator.h>
 
BPS_API int navigator_window_cover_attribute_set_capture(navigator_window_cover_attribute_t *attribute,
                                                         int x,
                                                         int y,
                                                         int width,
                                                         int height)

Since:

BlackBerry 10.0.0

Arguments:

attribute

The window cover attribute handle.

x

The X-axis origin

y

The Y-axis origin

width

The capture width

height

The capture height

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 a capture is being used, live and image file will be disabled. When using a capture, the portion of the screen to use is provided by x, y, width, and height parameters. Navigator will scale the image appropriately if it doesn't correspond to the proper window cover width and height.

Returns:

On success, BPS_SUCCESS. Otherwise, BPS_FAILURE with errno set, and attribute will be unchanged.