Freigeben über


IVsTextView.GetScrollInfo(Int32, Int32, Int32, Int32, Int32) Method

Definition

Returns the core text editor's scroll bar settings for the specified scroll bar.

public:
 int GetScrollInfo(int iBar, [Runtime::InteropServices::Out] int % piMinUnit, [Runtime::InteropServices::Out] int % piMaxUnit, [Runtime::InteropServices::Out] int % piVisibleUnits, [Runtime::InteropServices::Out] int % piFirstVisibleUnit);
int GetScrollInfo(int iBar, [Runtime::InteropServices::Out] int & piMinUnit, [Runtime::InteropServices::Out] int & piMaxUnit, [Runtime::InteropServices::Out] int & piVisibleUnits, [Runtime::InteropServices::Out] int & piFirstVisibleUnit);
public int GetScrollInfo (int iBar, out int piMinUnit, out int piMaxUnit, out int piVisibleUnits, out int piFirstVisibleUnit);
abstract member GetScrollInfo : int * int * int * int * int -> int
Public Function GetScrollInfo (iBar As Integer, ByRef piMinUnit As Integer, ByRef piMaxUnit As Integer, ByRef piVisibleUnits As Integer, ByRef piFirstVisibleUnit As Integer) As Integer

Parameters

iBar
Int32

[in] Specifies a horizontal or vertical scroll bar. Values may be either SB_HORZ or SB_VERT. For more information, see GetScrollInfo in the Platform SDK.

piMinUnit
Int32

[out] Minimum scroll bar unit.

piMaxUnit
Int32

[out] Maximum scroll bar unit.

piVisibleUnits
Int32

[out] Additional number of visible units in the scroll bar.

piFirstVisibleUnit
Int32

[out] First visible unit in the scroll bar.

Returns

If the method succeeds, it returns S_OK. If it fails, it returns an error code.

Remarks

COM Signature

From textmgr.idl:

HRESULT IVsTextView::GetScrollInfo(  
   [in] long iBar,  
   [out] long *piMinUnit,  
   [out] long *piMaxUnit,  
   [out] long *piVisibleUnits,  
   [out] long *piFirstVisibleUnit  
);  

The piFirstVisibleUnit and piVisibleUnits parameters define the visible range in the view. For example, if lines 10 through 25 were visible in the view, then piFirstVisibleUnit would have a value of 10 and piVisibleUnits would have a value of 15.

Note

Scroll bar information is not guaranteed to directly match line information. The values returned are based on the core text editor settings.

Applies to