IEnumRunningDocuments.Skip(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.

Skip over the specified number of document cookies in the enumeration sequence.

public:
 int Skip(System::UInt32 celt);

public:
 int Skip(unsigned int celt);

int Skip(unsigned int celt);

public int Skip (uint celt);

abstract member Skip : uint32 -> int

Public Function Skip (celt As UInteger) As Integer

Parameters

celt: UInt32

[in] The number of cookies to skip over.

Returns

Int32

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

Remarks

COM Signature

From vsshell.idl:

HRESULT IEnumRunningDocuments::Skip(  
   [in] ULONG celt  
);

If the celt parameter specifies more than the number of cookies remaining, this method returns S_FALSE and sets the enumeration to the end of the sequence.

Applies to

Share via