Edit

Share via

IEnumSTATPROPSTG::Clone method (propidlbase.h)

  • Article

The Clone method creates an enumerator that contains the same enumeration state as the current STATPROPSTG structure enumerator. Using this method, a client can record a particular point in the enumeration sequence and then return to that point later. The new enumerator supports the same IEnumSTATPROPSTG interface.

Syntax

HRESULT Clone(
  [out] IEnumSTATPROPSTG **ppenum
);

Parameters

[out] ppenum

A pointer to the variable that receives the IEnumSTATPROPSTG interface pointer.

If the method is unsuccessful, the value of the ppenum parameter is undefined.

Return value

This method supports the following return values.

Return code Description
E_INVALIDARG
 The ppenum parameter is NULL.
E_OUTOFMEMORY
 Insufficient memory.
E_UNEXPECTED
 An unexpected exception occurred.

Requirements

Requirement Value
Minimum supported client Windows 2000 Professional [desktop apps | UWP apps]
Minimum supported server Windows 2000 Server [desktop apps | UWP apps]
Target Platform Windows
Header propidlbase.h (include Propidl.h)
Library Uuid.lib
DLL Ole32.dll