Share via

NLED_SETTINGS_INFO (Compact 2013)

  • Article

3/26/2014

This structure contains information about the current settings of the specified notification LED.

Syntax

struct NLED_SETTINGS_INFO {
  UINT LedNum;
  INT OffOnBlink;
  LONG TotalCycleTime;
  LONG OnTime;
  LONG OffTime;
  INT MetaCycleOn;
  INT MetaCycleOff; 
} NLED_SETTINGS_INFO, *PNLED_SETTINGS_INFO;

Members

  • LedNum
    LED number. The first LED is zero (0).

  • OffOnBlink
    Current setting. The following table shows the defined values.

    Value

    Description

    NLED_OFF (0)

    Off

    NLED_ON (1)

    On

    NLED_BLINK (2)

    Blink

    Note

    Settings related to blinking are ignored unless OffOnBlink is set to NLED_BLINK. TotalCycleTime, OnTime, OffTime, MetaCycleOn, and MetaCycleOff are blink related settings.

  • TotalCycleTime
    Total cycle time of a blink, in microseconds. If this member is supported, then it must be greater than zero (0).
  • OnTime
    On time of the cycle, in microseconds. If this member is supported, then it must be greater than zero (0).
  • OffTime
    Off time of the cycle, in microseconds. If this member is supported, then it must be greater than zero (0).
  • MetaCycleOn
    Number of on blink cycles. If this member is supported, then it must be greater than or equal to one (1).
  • MetaCycleOff
    Number of off blink cycles. If this member is supported, then it must be greater than or equal to zero (0).

Remarks

The NLedGetDeviceInfo and NLedSetDevice functions use this structure.

For NLedGetDeviceInfo, the caller must first set LedNum to specify the notification component that is being queried.

For NLedSetDevice, some or all of the members related to blinking (TotalCycleTime, OnTime, OffTime, MetaCycleOn, MetaCycleOff) might be ignored depending on what the hardware supports. NLED_SUPPORTS_INFO can be queried for a notification component to indicate which structure members are used. The hardware might have a minimum or maximum value on these members, which can result in settings changing to minimum or maximum default values without notice.

Requirements

Header

nled.h

See Also

Reference

Notification LED Driver Structures
NLedDriverGetDeviceInfo
NLedGetDeviceInfo
NLedSetDevice
Notification LED Driver Enumerations
NLED_SUPPORTS_INFO