Share via


IEnumRunningDocuments.Next(UInt32, UInt32[], UInt32) Method

Definition

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

public:
 int Next(System::UInt32 celt, cli::array <System::UInt32> ^ rgelt, [Runtime::InteropServices::Out] System::UInt32 % pceltFetched);
int Next(unsigned int celt, std::Array <unsigned int> const & rgelt, [Runtime::InteropServices::Out] unsigned int & pceltFetched);
public int Next (uint celt, uint[] rgelt, out uint pceltFetched);
abstract member Next : uint32 * uint32[] * uint32 -> int
Public Function Next (celt As UInteger, rgelt As UInteger(), ByRef pceltFetched As UInteger) As Integer

Parameters

celt
UInt32

[in] The number of cookies to obtain.

rgelt
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
UInt32

[out] Returns the number of cookies actually fetched.

Returns

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:

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.

Applies to