Admin Production ni-theme
Current Publication

GetWindowsColor

LabWindows/CVI

GetWindowsColor

int GetWindowsColor (int displayElement, unsigned int *color);

Purpose

This function retrieves the 0RGB color of a Windows display element. This is useful if you want to query the OS for its display colors and adjust your own application's display elements, such as Graph plot areas, which are not affected by the Conform To System Colors attribute.

(Linux) This function is not supported.

Parameters

Input
Name Type Description
displayElement int The Windows display element to query for its color.
Output
Name Type Description
color unsigned int Returns the color of the display element. The most significant byte of this four–byte value will be 0, and the lower three bytes will contain the Red, Green, and Blue components of the color, respectively. This corresponds to the color format used throughout the CVI standard libraries.

Return Value

Name Type Description
status int The status code that the function returns.

0 indicates success.

A negative value indicates an error.

This function may return a Programmer's Toolbox or UI Library error code. Call GetGeneralErrorString to obtain a text description of the error.

Additional Information

Library: Programmer's Toolbox

Include file: toolbox\toolbox.h

LabWindows/CVI compatibility: LabWindows/CVI 5.5 and later