NLED_SUPPORTS_INFO (Compact 2013)

3/26/2014

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

Syntax

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

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 NLedGetDeviceInfo and NLedSetDevice functions use this structure.

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

The lCycleAdjust member specifies 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 notification component does not support blinking, this value should be negative one (-1). While some implementations might have set lCycleAdjust equal to negative one (-1) in the past to identify vibrators, this is not the supported functionality of this member. If the notification component supports blinking, but is not adjustable lCycleAdjust is set to zero (0).

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

For TotalCycleTime, OnTime, and OffTime a device must report one of the following settings:

1. The cycle time is not adjustable.

1. Only the overall cycle time is adjustable.

1. The on and off times are independently adjustable.

For MetaCycle support, a device must report one of the following settings:

1. Metacycle is not adjustable

1. Metacycle is adjustable

Requirements

See Also

Reference

Notification LED Driver Structures
NLedDriverGetDeviceInfo
NLedDriverSetDevice