VCGetToggleState

Version:

2.0

Description:

Specifies the toggle of a setting.

Declaration:

C/C++

extern "C" vbool WINAPI VCGetToggleState(WORD id, vbool tfReverseState);

Delphi

function VCGetToggleState(id: Smallint; tfReverseState: Wordbool): Wordbool; stdcall;

ActiveX/COM

Function GetToggleState(ByVal id As Integer, ByVal tfReverseState As Integer) As Integer

Parameters:

id - the command id of the command to be toggled. See the Additional Information section for a listing of native commands.
tfReverseState - true(1)/false(0) to indicate to reverse toggle setting.

Return Value:

the value of the toggle before applying any requested reversal of the state.

Notes:

This function is valid only for toggle settings. VCGetToggleState strictly toggles the command opposite of what it was previously when using tfReverseState as true(1), it will not explicitly toggle on or off.