NLedDriverGetDeviceInfo

Windows CE .NET

This function returns information about the notification LED device.

BOOL NLedDriverGetDeviceInfo(
  INT nId,
  PVOID pOutput 
);

Parameters

nId
[in] Integer specifying the information to return. The following table shows the defined values.
Value Description
NLED_COUNT_INFO_ID Indicates that the pOutput buffer specifies the number of notification LEDs on the device.
NLED_SUPPORTS_INFO_ID Indicates that the pOutput buffer specifies information about the capabilities supported by the notification LED.
NLED_SETTINGS_INFO_ID Indicates that the pOutput buffer contains information about the notification LED current settings.
pOutput
[out] Pointer to the buffer to return the information. The buffer points to various structure depending on the value of nId. The following table shows these structures.
Value of nID Structure in pOutput
NLED_COUNT_INFO_ID NLED_COUNT_INFO
NLED_SUPPORTS_INFO_ID NLED_SUPPORTS_INFO
NLED_SETTINGS_INFO_ID NLED_SETTINGS_INFO

Return Values

TRUE indicates success. FALSE indicates failure.

Remarks

Platforms without LEDs can set the cLeds member of p, which is of type NLED_COUNT_INFO, to zero (0). This sets the number of LEDs in the system to zero (0).

The following code example shows an implementation of NledDriverGetDeviceInfo.

BOOL
WINAPI
NLedDriverGetDeviceInfo(INT nInfoId, PVOID pOutput)
{
  if ( nInfoId == NLED_COUNT_INFO_ID ) {
    struct NLED_COUNT_INFO  *p = (struct NLED_COUNT_INFO*)pOutput;
    p -> cLeds = 0;
    return (TRUE);
  }
  SetLastError(ERROR_GEN_FAILURE);
  return (FALSE);
}

Requirements

OS Versions: Windows CE 1.0 and later.
Header: Led_drvr.h.
Link Library: Nleddrv.lib.

See Also

Notification LED Drivers | NLED_COUNT_INFO | NLED_SETTINGS_INFO | NLED_SUPPORTS_INFO


 Last updated on Tuesday, May 18, 2004

© 1992-2003 Microsoft Corporation. All rights reserved.

Show: