Partager via


IVsTextView.GetCaretPos(Int32, Int32) Method

Definition

Returns the line and column index of the cursor position.

public:
 int GetCaretPos([Runtime::InteropServices::Out] int % piLine, [Runtime::InteropServices::Out] int % piColumn);
int GetCaretPos([Runtime::InteropServices::Out] int & piLine, [Runtime::InteropServices::Out] int & piColumn);
public int GetCaretPos (out int piLine, out int piColumn);
abstract member GetCaretPos : int * int -> int
Public Function GetCaretPos (ByRef piLine As Integer, ByRef piColumn As Integer) As Integer

Parameters

piLine
Int32

[out] Pointer to an integer containing the line, if the method succeeds.

piColumn
Int32

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

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

Applies to