IVsTextViewEx.GetClusterRange(Int32, Int32, Int32, Int32, Int32) Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.TextManager.Interop

Assembly:: Microsoft.VisualStudio.TextManager.Interop.8.0.dll

Assembly:: Microsoft.VisualStudio.Interop.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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

public:
 int GetClusterRange(int iLine, int iDisplayCol, [Runtime::InteropServices::Out] int % picCharacter, [Runtime::InteropServices::Out] int % piStartCol, [Runtime::InteropServices::Out] int % piEndCol);

int GetClusterRange(int iLine, int iDisplayCol, [Runtime::InteropServices::Out] int & picCharacter, [Runtime::InteropServices::Out] int & piStartCol, [Runtime::InteropServices::Out] int & piEndCol);

public int GetClusterRange (int iLine, int iDisplayCol, out int picCharacter, out int piStartCol, out int piEndCol);

abstract member GetClusterRange : int * int * int * int * int -> int

Public Function GetClusterRange (iLine As Integer, iDisplayCol As Integer, ByRef picCharacter As Integer, ByRef piStartCol As Integer, ByRef piEndCol As Integer) As Integer

Parameters

iLine: Int32

[in] The line number.

iDisplayCol: Int32

[in] The character index.

picCharacter: Int32

[out] The character count.

piStartCol: Int32

[out] The start character index.

piEndCol: Int32

[out] The end character index.

Returns

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

Applies to