navigator_set_orientation

Set the orientation in the navigator based on landscape or portrait.

Synopsis:

#include <bps/navigator.h>

BPS_API int navigator_set_orientation_mode(int mode,
                                           char **id)

Since:

BlackBerry 10.0.0

Arguments:

mode: NAVIGATOR_LANDSCAPE, NAVIGATOR_PORTRAIT.

id: If not null, the ID used in the orientation request will be returned in id. The caller must free this buffer using bps_free().

Library:

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

Description:

The navigator_set_orientation_mode() function sends a navigator orientation request to set the orientation in the navigator to the chosen mode (NAVIGATOR_LANDSCAPE, or NAVIGATOR_PORTRAIT).

Returns:

BPS_SUCCESS upon success, BPS_FAILURE with errno set otherwise.