IEnumFORMATETC::Clone

A version of this page is also available for

Windows Embedded CE 6.0 R3

4/8/2010

This method creates another enumerator that contains the same enumeration state as the current one.

Using this function, a client can record a particular point in the enumeration sequence and then return to that point at a later time.

The new enumerator supports the same interface as the original one.

Syntax

HRESULT Clone(
  IEnumFORMATETC** ppenum
);

Parameters

• ppenum
  [out] Address of the IEnumFORMATETC* pointer variable that receives the interface pointer to the enumeration object.

  If the method is unsuccessful, the value of this output variable is undefined.

Return Value

This method supports the standard return values E_INVALIDARG, E_OUTOFMEMORY, and E_UNEXPECTED.

Remarks

To determine whether the platform supports this interface, see Determining Supported COM APIs.

Requirements