IVsEnumTaskItems.Next(UInt32, IVsTaskItem[], UInt32[]) Method

Definition

Namespace:

Microsoft.VisualStudio.Shell.Interop

Assembly:

Microsoft.VisualStudio.Interop.dll

Package:

Microsoft.VisualStudio.Interop v17.12.40391

Retrieves a specified number of task items in the enumeration sequence.

int Next(unsigned int celt, std::Array <Microsoft::VisualStudio::Shell::Interop::IVsTaskItem const &> const & rgelt, std::Array <unsigned int> const & pceltFetched);

public int Next (uint celt, Microsoft.VisualStudio.Shell.Interop.IVsTaskItem[] rgelt, uint[] pceltFetched);

abstract member Next : uint32 * Microsoft.VisualStudio.Shell.Interop.IVsTaskItem[] * uint32[] -> int

Public Function Next (celt As UInteger, rgelt As IVsTaskItem(), Optional pceltFetched As UInteger()) As Integer

Parameters

celt

UInt32

[in] The requested number of task items to retrieve.

rgelt

IVsTaskItem[]

[out, size_is(celt), length_is(*pceltFetched)] The list of IVsTaskItem2 interfaces of the task items that have been retrieved.

pceltFetched

UInt32[]

[out] Pointer to the actual number of tasks supplied in rgelt. The caller of this method can set this to null if celt is one.

Returns

Int32

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

Remarks

COM Signature

From vsshell.idl:

HRESULT IVsEnumTaskItems::Next(  
   [in] ULONG celt,  
   [out, size_is(celt), length_is(*pceltFetched)] IVsTaskItem **rgelt,  
   [out, optional] ULONG *pceltFetched  
);  

The tasks are retrieved from the current position of the enumeration. The Reset and Skip methods of this interface can be used to get to a particular position of the enumeration before using IVsEnumTaskItems.Next to retrieve task items from the enumeration.

Refer to the Remarks under the Reset method.