IEnumRunningDocuments.Skip Method

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

Namespace:  Microsoft.VisualStudio.Shell.Interop
Assembly:  Microsoft.VisualStudio.Shell.Interop (in Microsoft.VisualStudio.Shell.Interop.dll)

Syntax

'Declaration
Function Skip ( _
    celt As UInteger _
) As Integer
int Skip(
    uint celt
)
int Skip(
    [InAttribute] unsigned int celt
)
abstract Skip : 
        celt:uint32 -> int
function Skip(
    celt : uint
) : int

Parameters

  • celt
    Type: System.UInt32

    [in] The number of cookies to skip over.

Return Value

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

.NET Framework Security

See Also

Reference

IEnumRunningDocuments Interface

Microsoft.VisualStudio.Shell.Interop Namespace