docs

Home Window Dimming functions Window Dimming

vuFTGetDimmingEnabled()

vuFTGetDimmingEnabled(), SIGNED, PROC, PASCAL, RAW

Description

Read current process-wide dimming state. This function is exported by vuFT5.dll and declared by the vuFileTools global template.

Parameters

Parameter Data type Description
None   No arguments

Returns

The result is a signed LONG. Positive numbers indicate success or an accepted active state, 0 may indicate an inactive or unregistered state, and negative numbers indicate specific errors. For this status function, 1 normally means enabled and 0 disabled.

Example

DimmingEnabled = vuFTGetDimmingEnabled()

Notes

Normally returns 1 when enabled and 0 when disabled; a negative return indicates an initialization or runtime failure.

See the Window Dimming guide, Window Dimming overview, and Troubleshooting. The EXE requires a Windows 8-or-later compatibility manifest.

Home Window Dimming functions Window Dimming

See Automatic Message Dimming for the global-template setup, or Custom Colored Message Procedures to import optional black, blue and red messages.