holster_event_get_holster_status()

#include <bps/holster.h>
 

BPS_API int holster_event_get_holster_status(bps_event_t *event)

Since:

BlackBerry 10.0.0

Arguments:

event

The HOLSTER_INFO event to extract the holster status from.

Library:

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

Description:

The holster_event_get_holster_status() function extracts the holster status of a device. The holster status is used to determine whether or not the the device is holstered by reading the specified HOLSTER_INFO event.

Returns:

HOLSTER_HOLSTER_IN if the device is holstered, HOLSTER_HOLSTER_OUT if it isn't, or BPS_FAILURE upon error with errno set.