IVsTaskList2.GetCaretPos(IVsTaskItem) Method

Definition

Namespace:

Microsoft.VisualStudio.Shell.Interop

Assembly:

Microsoft.VisualStudio.Interop.dll

Package:

Microsoft.VisualStudio.Interop v17.12.40391

Returns the item that currently has the caret. This item is always among the selected items.

public:
 int GetCaretPos([Runtime::InteropServices::Out] Microsoft::VisualStudio::Shell::Interop::IVsTaskItem ^ % ppItem);

public:
 int GetCaretPos([Runtime::InteropServices::Out] Microsoft::VisualStudio::Shell::Interop::IVsTaskItem ^ &  ppItem);

int GetCaretPos([Runtime::InteropServices::Out] Microsoft::VisualStudio::Shell::Interop::IVsTaskItem const & & ppItem);

public int GetCaretPos (out Microsoft.VisualStudio.Shell.Interop.IVsTaskItem ppItem);

abstract member GetCaretPos : IVsTaskItem -> int

Public Function GetCaretPos (ByRef ppItem As IVsTaskItem) As Integer

Parameters

ppItem

IVsTaskItem

[out] A pointer to a pointer to an object of type IVsEnumTaskItems.

Returns

Int32

If the method succeeds, it returns S_OK. If it fails, it returns an error code.

Remarks

If no item has the caret, this method will return NULL.

COM Signature

From vsshell80.idl:

HRESULT GetCaretPos(  
   [out] IVsTaskItem** ppItem  
);