NLED_SUPPORTS_INFO

Windows CE .NET

This structure contains information about the capabilities of the specified LED.

struct NLED_SUPPORTS_INFO {
  UINT LedNum;
  LONG lCycleAdjust;
  BOOL fAdjustTotalCycleTime;
  BOOL fAdjustOnTime;
  BOOL fAdjustOffTime;
  BOOL fMetaCycleOn;
  BOOL fMetaCycleOff; 
};

Members

LedNum
Number of the LED. The first LED is zero (0).
lCycleAdjust
Granularity of the cycle-time adjustments, in microseconds.
fAdjustTotalCycleTime
TRUE if the LED has an adjustable total cycle time; otherwise, it is FALSE.
fAdjustOnTime
TRUE if the LED has a separate on time; otherwise, it is FALSE.
fAdjustOffTime
TRUE if the LED has separate off time; otherwise, it is FALSE.
fMetaCycleOn
TRUE if the LED can blink n cycles, pause, and blink n cycles; otherwise, it is FALSE.
fMetaCycleOff
TRUE if the LED can blink n cycles, pause n cycles, and blink n cycles; otherwise, it is FALSE.

Remarks

The NLedDriverGetDeviceInfo and NLedDriverSetDevice functions use this structure.

The caller should first get the number of notification LEDs on the system. This is usually 1 but may be zero (0) and could be greater than 1. The caller should fill in the Lednum and then call NLedDriverGetDeviceInfo. LED numbering starts at zero (0).

The lCycleAdjust member is the granularity to which cycle time adjustments can be made. For example if the granularity is 1/16 second, lCycleAdjust equals 62500 microseconds. If the LED does not support blinking, this value should be zero (0).

Values are given in microseconds only to deal with computations involving fractional milliseconds. Usually only settings in the milliseconds range are meaningful.

Usually a device will report that it supports up to two of fAdjustTotalCycleTime, fAdjustOnTime, and fAdjustOffTime; any two determine the third.

The following table shows the most likely settings.

Setting Value Description
fAdjustTotalCycleTime FALSE The cycle time is not adjustable.
fAdjustOnTime FALSE The cycle time is not adjustable.
fAdjustOffTime FALSE The cycle time is not adjustable.
fAdjustTotalCycleTime TRUE Only the overall cycle time is adjustable.
fAdjustOnTime FALSE Only the overall cycle time is adjustable.
fAdjustOffTime FALSE Only the overall cycle time is adjustable.
fAdjustTotalCycleTime FALSE The on and off times are independently adjustable.
fAdjustOnTime TRUE The on and off times are independently adjustable.
fAdjustOffTime TRUE The on and off times are independently adjustable.

Requirements

OS Versions: Windows CE 1.0 and later.
Header: Nled.h.

See Also

Notification LED Drivers | NLedDriverGetDeviceInfo | NLedDriverSetDevice


 Last updated on Tuesday, May 18, 2004

© 1992-2003 Microsoft Corporation. All rights reserved.

Show: