IEnumRunningDocuments::Next Method (UInt32, array<UInt32>^, UInt32)

Visual Studio 2015

Returns a specified number of document cookies from the enumeration sequence.

Namespace: Microsoft.VisualStudio.Shell.Interop
Assembly: Microsoft.VisualStudio.Shell.Interop (in Microsoft.VisualStudio.Shell.Interop.dll)

Syntax

C++

int Next(
	unsigned int celt,
	array<unsigned int>^ rgelt,
	[OutAttribute] unsigned int% pceltFetched
)

Parameters

celt: Type: System::UInt32
[in] The number of cookies to obtain.

rgelt: Type: array<System::UInt32>^
[in, out] An array to be filled in with the requested cookies. The size of this array must be at least celt members.

pceltFetched: Type: System::UInt32
[out] Returns the number of cookies actually fetched.

Return Value

Type: System::Int32

If the method succeeds, it returns S_OK. Returns S_FALSE if there were fewer than the specified number of cookies remaining; otherwise, returns an error code.

Remarks

COM Signature

From vsshell.idl:

C++

HRESULT IEnumRunningDocuments::Next(
   [in] ULONG celt, 
   [out, size_is(celt), length_is(*pceltFetched)] VSCOOKIE *rgelt,    [out] ULONG *pceltFetched
);

A document cookie is a unique value representing a document and only the RDT knows what the cookie really means. Treat the cookie as an unsigned integer in all cases.