3.4.5.2.1.2 IEnumVdsObject::Skip (Opnum 4)

  • Article

 The Skip method skips a specified number of objects in the enumeration. 

 [helpstring("method Skip")] HRESULT Skip(
   [in] unsigned long celt
 );

celt: The number of objects to skip.

Return Values: The method MUST return zero or a non-error HRESULT (as specified in [MS-ERREF]) to indicate success or return an implementation-specific nonzero error code to indicate failure. For the HRESULT values predefined by the Virtual Disk Service Remote Protocol, see section 2.2.3.

If S_FALSE is returned, the enumeration has ended and the client MUST either stop enumerating or reset the enumeration back to the beginning.

When the server receives this message, it MUST perform the following:

  • If the number of objects from the current index to the end of the enumeration is greater than or equal to the number in celt, increment the current index by celt and return an HRESULT that indicates failure or success.

  • If the number of objects from the current index to the end of the enumeration is less than the number of objects that celt requested, increment the current index by the number of objects from the current index to the end of the enumeration and return S_FALSE (HRESULT of 0x00000001) if successful.

  • If the current index is already past the list of objects in the enumeration, return S_FALSE (HRESULT of 0x00000001) if successful.