IOpcRelationshipEnumerator::GetCurrent method (msopc.h)

Gets the IOpcRelationship interface pointer at the current position of the enumerator.

Syntax

HRESULT GetCurrent(
  [out, retval] IOpcRelationship **relationship
);

Parameters

[out, retval] relationship

An IOpcRelationship interface pointer.

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 partReference parameter is NULL.
OPC_E_ENUM_COLLECTION_CHANGED
0x80510050
The enumerator is invalid because the underlying set has changed.
OPC_E_ENUM_INVALID_POSITION
0x80510053
The enumerator cannot perform this operation from its current position.

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

See also

Getting Started with the Packaging API

IOpcRelationshipEnumerator

IOpcRelationshipSet

Overviews

Packaging API Reference

Packaging API Samples

Packaging Errors

Reference