Share via


IEnumRunningDocuments.Skip(UInt32) Method

Definition

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

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