DspIsButtonGray

Gets the current status of a button.

Note: This function was designed to only be used on Cicode objects, or the animation point object from the version 3.xx/4.xx toolbox.

Syntax

DspIsButtonGray(nAN)

nAN:

The AN for which object information is provided.

Return Value

The current mode of the button:

• 0 - The button is active (not grayed).

• 1 - (SUNK_GRAY) The button is inactive (the text or symbol on the button is recessed).

• 2 - (PART_GRAY) This mode is now obsolete. The button will be inactive even if part_gray is returned.

• 3 - (ALL_GRAY) The button is inactive (the entire button is masked).

Related Functions

DspButton, DspButtonFn, DspGrayButton

Example

! Check the status of the button at AN21
status = DspIsButtonGray(21);

See Also

Display Functions