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

Reference

Definition

Namespace:: Microsoft.VisualStudio.Shell.Interop

Assembly:: Microsoft.VisualStudio.Shell.Interop.dll

Assembly:: Microsoft.VisualStudio.Interop.dll

Package:: Microsoft.VisualStudio.Interop v17.11.40262

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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

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:

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

Share via