IEnumRunningDocuments.Next Method

2015-04-29

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

'Declaration
Function Next ( _
    celt As UInteger, _
    <OutAttribute> rgelt As UInteger(), _
    <OutAttribute> ByRef pceltFetched As UInteger _
) As Integer

int Next(
    uint celt,
    uint[] rgelt,
    out uint pceltFetched
)

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

abstract Next : 
        celt:uint32 * 
        rgelt:uint32[] byref * 
        pceltFetched:uint32 byref -> int

function Next(
    celt : uint, 
    rgelt : uint[], 
    pceltFetched : uint
) : int

Parameters

celt
Type: UInt32

[in] The number of cookies to obtain.

rgelt
Type: array<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: UInt32%

[out] Returns the number of cookies actually fetched.

Return Value

Type: 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.

.NET Framework Security

Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.

Share via