Edit

IEnumVdsObject::Clone method (vdshwprv.h)

  • Article

[Beginning with Windows 8 and Windows Server 2012, the Virtual Disk Service COM interface is superseded by the Windows Storage Management API.]

Creates an enumeration with the same state as the current enumeration.

Syntax

HRESULT Clone(
  [out] IEnumVdsObject **ppEnum
);

Parameters

[out] ppEnum

The address of an IEnumVdsObject pointer, which VDS initializes on return. Callers must release the interface.

Return value

This method can return standard HRESULT values, such as E_INVALIDARG or E_OUTOFMEMORY, and VDS-specific return values. It can also return converted system error codes using the HRESULT_FROM_WIN32 macro. Errors can originate from VDS itself or from the underlying VDS provider that is being used. Possible return values include the following.

Return code Description
S_OK
 The new enumeration has been created.

Remarks

This method enables you to record a point in an enumeration and return to that point later. When the new, cloned enumeration is returned, it is at the same point in the enumeration sequence as the original. Henceforth, however, the clone and the original enumeration operate independently.

Requirements

Requirement Value
Minimum supported client Windows Vista [desktop apps only]
Minimum supported server Windows Server 2003 [desktop apps only]
Target Platform Windows
Header vdshwprv.h
Library Uuid.lib

See also

IEnumVdsObject