Share via


IVsTextViewEx.GetClusterRange Method

Returns cluster range information for the given line number and character index.

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

Syntax

'Declaration
Function GetClusterRange ( _
    iLine As Integer, _
    iDisplayCol As Integer, _
    <OutAttribute> ByRef picCharacter As Integer, _
    <OutAttribute> ByRef piStartCol As Integer, _
    <OutAttribute> ByRef piEndCol As Integer _
) As Integer
int GetClusterRange(
    int iLine,
    int iDisplayCol,
    out int picCharacter,
    out int piStartCol,
    out int piEndCol
)
int GetClusterRange(
    [InAttribute] int iLine, 
    [InAttribute] int iDisplayCol, 
    [OutAttribute] int% picCharacter, 
    [OutAttribute] int% piStartCol, 
    [OutAttribute] int% piEndCol
)
abstract GetClusterRange : 
        iLine:int * 
        iDisplayCol:int * 
        picCharacter:int byref * 
        piStartCol:int byref * 
        piEndCol:int byref -> int
function GetClusterRange(
    iLine : int, 
    iDisplayCol : int, 
    picCharacter : int, 
    piStartCol : int, 
    piEndCol : int
) : int

Parameters

  • picCharacter
    Type: System.Int32%

    [out] The character count.

  • piStartCol
    Type: System.Int32%

    [out] The start character index.

  • piEndCol
    Type: System.Int32%

    [out] The end character index.

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 textmgr2.idl:

HRESULT IVsTextViewEx::GetClusterRange(
   [in]long iLine, 
   [in]INT iDisplayCol, 
   [out]INT *picCharacter, 
   [out]INT *piStartCol, 
   [out]INT *piEndCol
);

Returns cluster range info given the line number and index of current character

.NET Framework Security

See Also

Reference

IVsTextViewEx Interface

Microsoft.VisualStudio.TextManager.Interop Namespace