Skip to content

IsBatteryLifeEnabled

Navigation: ADLX SDK ReferencesADLX InterfacesDisplayIADLXDisplayVariBright1

Syntax

ADLX_RESULT    IsBatteryLifeEnabled (adlx_bool* enabled)

Parameters

#DirectionNameTypeDescription
1.[out]enabledadlx_bool*The pointer to a variable where the state of Battery Life Vari-Bright Scaling mode is returned. The variable is true if Battery Life Vari-Bright Scaling mode is enabled. The variable is false if Battery Life Vari-Bright Scaling mode is not enabled.

Return Value

If the state of Battery Life Vari-Bright Scaling mode is successfully returned, ADLX_OK is returned.

If the state of Battery Life Vari-Bright Scaling mode is not successfully returned, an error code is returned.

Refer to ADLX_RESULT for success codes and error codes.

Requirements

Headerinclude “IDisplaySettings.h”
Minimum version1.4

See Also: ADLX Enums