vibration_event_get_time_left()

#include <bps/vibration.h>
 

BPS_API int vibration_event_get_time_left(bps_event_t *event,
                                          int *time_left)

Since:

BlackBerry 10.0.0

Arguments:

event

The VIBRATION_INFO event to get the time left from.

time_left

If the device is vibrating, then this is set to the number of milliseconds before the vibration is over. A value of zero means that the device is no longer vibrating. A value less than zero means that the device will vibrate until the vibration is cancelled.

Library:

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

Description:

The vibration_event_get_time_left() function gets the remaining vibration time from a VIBRATION_INFO event.

Returns:

BPS_SUCCESS upon success, BPS_FAILURE with errno set otherwise.