IVsTextView::GetCaretPos Method (Int32, Int32)

Visual Studio 2015

Returns the line and column index of the cursor position.

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

Syntax

C++

int GetCaretPos(
	[OutAttribute] int% piLine,
	[OutAttribute] int% piColumn
)

Parameters

piLine: Type: System::Int32
[out] Pointer to an integer containing the line, if the method succeeds.

piColumn: Type: System::Int32
[out] Pointer to an integer containing the column, if the method succeeds. Viewcol coordinates may include virtual space.

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:

C++

HRESULT IVsTextView::GetCaretPos(
   [out] long *piLine,
   [out] ViewCol *piColumn
);

The caret position is the cursor position. Use GetCaretPos to manage the caret or the insertion point. The piLine or piColumn parameters can be null if only one is needed.