Share via

NLedDriverGetDeviceInfo (Compact 2013)

  • Article

3/26/2014

This function returns information about the notification LED device.

Syntax

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.

    NLED_TYPE_INFO_ID

    Indicates that the pOutput buffer contains information about the notification LED type (LED, Vibrator).

  • pOutput
    [out] Pointer to the buffer to return the information. The buffer points to various structures depending on the value of nId. The following table shows these structures.

    Value ofnID

    Structure in pOutput

    NLED_COUNT_INFO_ID

    NLED_COUNT_INFO

    NLED_SUPPORTS_INFO_ID

    NLED_SUPPORTS_INFO

    NLED_SETTINGS_INFO_ID

    NLED_SETTINGS_INFO

    NLED_TYPE_INFO_ID

    NLED_TYPE_INFO

Return Value

TRUE indicates success. FALSE indicates failure.

Remarks

Beginning with Windows Embedded Compact 2013, the functionality provided by NLedDriverGetDeviceInfo is no longer implemented within the notification LED platform dependent driver (PDD) for default IOCTLs. However, it is still necessary to implement NLedDriverGetDeviceInfo as a stub function that returns FALSE. Hardware information should be reported in the notification LED driver registry settings. For more information on the notification LED driver registry settings, see Notification LED Driver Registry Settings.

Requirements

Header

led_drvr.h

Library

Nleddrv.lib

See Also

Reference

Notification LED Driver Functions
NLED_COUNT_INFO
NLED_SETTINGS_INFO
NLED_SUPPORTS_INFO