NLedDriverGetDeviceInfo

This function returns information about the notification LED device.

BOOL NLedDriverGetDeviceInfo (
INT nId, 
PVOID pOutput );

Parameters

  • nId
    Integer specifying the information to be returned. The following values are defined:

    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
    Pointer to the buffer to which the information is to be returned. The buffer points to various structure types, depending on the value of nId, as detailed in the following table.

    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

Implement this GWES function as part of porting native device drivers.

Requirements

Runs on Versions Defined in Include Link to
Windows CE OS 1.0 and later Led_drvr.h    

Note   This API is part of the complete Windows CE OS package as provided by Microsoft. The functionality of a particular platform is determined by the original equipment manufacturer (OEM) and some devices may not support this API.

See Also

NLED_COUNT_INFO, NLED_SETTINGS_INFO, NLED_SUPPORTS_INFO

 Last updated on Tuesday, July 13, 2004

© 1992-2000 Microsoft Corporation. All rights reserved.