navigator_orientation_check_response_id()

#include <bps/navigator.h>
 

BPS_API int navigator_orientation_check_response_id(const char *id,
                                                    bool will_rotate)

Since:

BlackBerry 10.0.0

Arguments:

id

The ID, as retrieved from the NAVIGATOR_ORIENTATION_CHECK event using navigator_event_get_id().

will_rotate

If true your application intends to rotate, if false your application does not intend to rotate.

Library:

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

Description:

The navigator_orientation_check_response_id() function specifies to the navigator whether or not your application intends to rotate. If you respond with true (that your application intends to rotate) then the navigator will send you a follow-up NAVIGATOR_ORIENTATION event when it is time for your application to resize its screen.

This function provides an alternative to the navigator_orientation_check_response() function, which requires the NAVIGATOR_ORIENTATION_CHECK event to be passed in. In the case where the NAVIGATOR_ORIENTATION_CHECK event will no longer be available to be passed in, the id can be retrieved from it, stored, and used in this function.

Returns:

BPS_SUCCESS upon success, BPS_FAILURE with errno set otherwise.