IVsTextView.GetScrollInfo Method

Article
05/06/2010

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

Namespace: Microsoft.VisualStudio.TextManager.Interop
Assembly: Microsoft.VisualStudio.TextManager.Interop (in Microsoft.VisualStudio.TextManager.Interop.dll)

Syntax

'Déclaration
Function GetScrollInfo ( _
    iBar As Integer, _
    <OutAttribute> ByRef piMinUnit As Integer, _
    <OutAttribute> ByRef piMaxUnit As Integer, _
    <OutAttribute> ByRef piVisibleUnits As Integer, _
    <OutAttribute> ByRef piFirstVisibleUnit As Integer _
) As Integer
'Utilisation
Dim instance As IVsTextView
Dim iBar As Integer
Dim piMinUnit As Integer
Dim piMaxUnit As Integer
Dim piVisibleUnits As Integer
Dim piFirstVisibleUnit As Integer
Dim returnValue As Integer

returnValue = instance.GetScrollInfo(iBar, _
    piMinUnit, piMaxUnit, piVisibleUnits, _
    piFirstVisibleUnit)

int GetScrollInfo(
    int iBar,
    out int piMinUnit,
    out int piMaxUnit,
    out int piVisibleUnits,
    out int piFirstVisibleUnit
)

int GetScrollInfo(
    [InAttribute] int iBar, 
    [OutAttribute] int% piMinUnit, 
    [OutAttribute] int% piMaxUnit, 
    [OutAttribute] int% piVisibleUnits, 
    [OutAttribute] int% piFirstVisibleUnit
)

abstract GetScrollInfo : 
        iBar:int * 
        piMinUnit:int byref * 
        piMaxUnit:int byref * 
        piVisibleUnits:int byref * 
        piFirstVisibleUnit:int byref -> int

function GetScrollInfo(
    iBar : int, 
    piMinUnit : int, 
    piMaxUnit : int, 
    piVisibleUnits : int, 
    piFirstVisibleUnit : int
) : int

Parameters

iBar
Type: System.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
Type: System.Int32%
[out] Minimum scroll bar unit.

piMaxUnit
Type: System.Int32%
[out] Maximum scroll bar unit.

piVisibleUnits
Type: System.Int32%
[out] Additional number of visible units in the scroll bar.

piFirstVisibleUnit
Type: System.Int32%
[out] First visible unit in the scroll bar.

Return Value

Type: System.Int32
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.

Notes

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

.NET Framework Security

Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.

Partager via