Rockwell Automation 6182 SDK - Manual (Page 56)

4–16 RAC6182-Specific Extensions to the CE API
Publication 6182-UM002B-EN-P
Macro Description
NLED_SUPPORTS_
INFO_ID Use to request capability information about any one of the LEDs in
the system.
pOutput should point to a caller allocated structure defined (in
nleddrv.h) as follows:
struct NLED_SUPPORTS_INFO {
UINT LedNum;
LONG lCycleAdjust; Granularity (usec)
BOOL fAdjustTotalCycleTime;
BOOL fAdjustOnTime;
BOOL fAdjustOffTime;
BOOL fMetaCycleOn;
BOOL fMetaCycleOff;
};
Prior to calling this function, the individual LED for which
information is sought must be selected by evaluating LedNum
using one of the following macros (defined in nledapi.h):
ID_WARNING_LED
ID_NUMLOCK_LED
ID_POWER_LED
When the function returns the other members of the structure will
contain information about the LED’s capabilities. For Booleans,
TRUE means that the parameter is adjustable with a
NLedSetDevice call. lCycleAdjust is the resolution of the timer (in
usec) that controls blink-on and blink-off.
NLED_SETTINGS_
INFO_ID Use to request current settings of any one of the LEDs in the
system.
pOutput should point to a caller allocated structure defined (in
nleddrv.h) as follows:
struct NLED_SETTINGS_INFO {
UINT LedNum;
INT OffOnBlink; // 0=off, 1=on, 2=blink
LONG TotalCycleTime; // (usec)
LONG OnTime; // blink-on time(usec)
LONG OffTime; // blink-off time(usec)
INT MetaCycleOn; // num blink-on cycles
INT MetaCycleOff; // numblink-off cycles
};
Prior to calling this function, the LED for which setting information
is sought must be selected. This is done by evaluating LedNum
using one of the following macros (defined in nledapi.h):
ID_WARNING_LED
ID_NUMLOCK_LED
ID_POWER_LED
When the function returns, current settings will be stored in the
corresponding members of the NLED_SETTINGS_INFO
structure.
Return Value
One of the following: TRUE or FALSE.