Share via

IToggleProvider::ToggleState Property

  • Article

Gets the toggle state of the control.

Syntax

HRESULT IToggleProvider::get_ToggleState(ToggleState *pRetVal);

Parameters

  • pRetVal
    [retval][out] The address of a variable that receives a value from the ToggleState enumerated type. This parameter is passed uninitialized.

Return Value

Returns S_OK if successful, or an error value otherwise.

Remarks

A control must cycle through its ToggleState in this order: ToggleState.On, ToggleState.Off and if supported, ToggleState.Indeterminate.

See Also

UI Automation Providers Overview