Share via

NLedDriverSetDevice (Compact 2013)

  • Article

3/26/2014

This function changes the setting of a notification LED.

Syntax

BOOL NLedDriverSetDevice(
  INT nInfoId,
  PVOID pInput 
);

Parameters

  • nInfoId
    [in] Indicates what kind of configuration information is being changed. The only supported value is NLED_SETTINGS_INFO_ID, which indicates that the pInput buffer contains information about the current settings for the notification LED.
  • pInput
    [out] Pointer to the buffer that contains the NLED_SETTINGS_INFO structure. This structure contains the new settings for the notification LED. The driver should ignore unsupported parameters and only return FALSE if a supported parameter is incorrect. For information about the correct value ranges for supported parameters, see the NLED_SETTINGS_INFO topic.

Return Value

TRUE indicates success. FALSE indicates failure.

Remarks

The NLedDriverSetDevice function changes the setting of the notification LED. Platforms with no LEDs can call SetLastError and return FALSE.

Requirements

Header

led_drvr.h

Library

Nleddrv.lib

See Also

Reference

Notification LED Driver Functions
NLED_SETTINGS_INFO