Share via


VsTextViewClass.GetCaretPos Method

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

'Declaration
Public Overridable Function GetCaretPos ( _
    <OutAttribute> ByRef piLine As Integer, _
    <OutAttribute> ByRef piColumn As Integer _
) As Integer
public virtual int GetCaretPos(
    out int piLine,
    out int piColumn
)
public:
virtual int GetCaretPos(
    [OutAttribute] int% piLine, 
    [OutAttribute] int% piColumn
)
abstract GetCaretPos : 
        piLine:int byref * 
        piColumn:int byref -> int  
override GetCaretPos : 
        piLine:int byref * 
        piColumn:int byref -> int
public function GetCaretPos(
    piLine : int, 
    piColumn : int
) : int

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.

Implements

IVsTextView.GetCaretPos(Int32%, Int32%)

.NET Framework Security

See Also

Reference

VsTextViewClass Class

Microsoft.VisualStudio.TextManager.Interop Namespace