led_request_color()

Request that the LEDs flash a named color.

Synopsis:

#include <bps/led.h>

BPS_API int led_request_color(const char *id,
                              led_color_t color,
                              int blink_count)

Since:

BlackBerry 10.0.0

Arguments:

id: An identifier for this request. This is used when updating a request by calling led_request_color() or led_request_rgb() again or when canceling a request with led_cancel().

color: The color to flash the LEDs.

blink_count: The number of times to blink. Use a value of 0 to continue blinking until canceled or until the application exits.

Library:

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

Description:

The led_request() function requests that the LEDs flash the named color and the specified number of times. If the application does not have the access_led_control capability, this function will fail.

Returns:

BPS_SUCCESS upon success, BPS_FAILURE with errno set otherwise.