Share via

IScrollProvider::HorizontalScrollPercent Property

  • Article

Gets the current horizontal scroll position.

Syntax

HRESULT IScrollProvider::get_HorizontalScrollPercent(double *pRetVal);

Parameters

  • pRetVal
    [retval][out] The address of a variable that receives the horizontal scroll position as a percentage of the total content area within the Microsoft UI Automation element. This parameter is passed uninitialized.

Return Value

Returns S_OK if successful, or an error value otherwise.

Remarks

The horizontal scroll position can be reported as UIA_ScrollPatternNoScroll if no valid position is available; for example, if the window does not have a horizontal scroll bar.

See Also

IScrollProvider, IScrollProvider::VerticalScrollPercent, UI Automation Providers Overview