DlnLedGetState() Function

The DlnLedGetState() function retrieves the current state of the LED.

Syntax

C/C++

DLN_RESULT DlnLedGetState(
   HDLN handle,
   uint8_t ledNumber
   DLN_LED_STATE* state
);

Parameters

handle: A handle to the DLN-series adapter.
ledNumber: A number of the LED which state you want to know.
state: A pointer to the DLN_LED_STATE type, where the LED state is stored.

Return Value

DLN_RES_SUCCESS (0x00): The function was successful.
DLN_RES_INVALID_LED_NUMBER (0xA6): The specified LED number is not valid. Use the DlnLedGetCount()function to find the maximum possible LED number.

Remarks

The DlnLedGetState() function is declared in the dln_led.h file.