Share via


IVsIntellisenseHost.GetSubjectCaretPos Method

Gets the caret position for the text upon which IntelliSense operates.

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

Syntax

'Declaration
Function GetSubjectCaretPos ( _
    <OutAttribute> ByRef piIndex As Integer _
) As Integer
int GetSubjectCaretPos(
    out int piIndex
)
int GetSubjectCaretPos(
    [OutAttribute] int% piIndex
)
abstract GetSubjectCaretPos : 
        piIndex:int byref -> int
function GetSubjectCaretPos(
    piIndex : int
) : int

Parameters

  • piIndex
    Type: System.Int32%

    [out] The index of the caret position.

Return Value

Type: System.Int32
If the method succeeds, it returns S_OK. If it fails, it returns an error code.

Remarks

The subject text is considered to be the contents of the context buffer if GetHostFlags()_returns flags containing IHF_NOSEPARATESUBJECT and this method should return E_NOTIMPL.

C++

From singlefileeditor.idl:

HRESULT IVsIntellisenseHost::GetSubjectCaretPos([out] long *piIndex);

.NET Framework Security

See Also

Reference

IVsIntellisenseHost Interface

Microsoft.VisualStudio.TextManager.Interop Namespace