IOpcRelationshipEnumerator::Clone method (msopc.h)

Article
02/22/2024

Creates a copy of the current enumerator and all its descendants.

Syntax

HRESULT Clone(
  [out, retval] IOpcRelationshipEnumerator **copy
);

Parameters

[out, retval] copy

A pointer to the IOpcRelationshipEnumerator interface of the new enumerator.

Return value

The method returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return code/value	Description
S_OK	The method succeeded.
E_POINTER	The copy parameter is NULL.
OPC_E_ENUM_COLLECTION_CHANGED 0x80510050	The enumerator is invalid because the underlying set has changed.

Remarks

When an enumerator is created, the current position precedes the first pointer. To set the current position to the first pointer of the enumerator, call the MoveNext method after creating the enumerator.

Thread Safety

Packaging objects are not thread-safe.

For more information, see the Getting Started with the Packaging API.

Requirements

Requirement	Value
Minimum supported client	Windows 7 [desktop apps only]
Minimum supported server	Windows Server 2008 R2 [desktop apps only]
Target Platform	Windows
Header	msopc.h

Share via