IOpcRelationshipSet::GetRelationship method (msopc.h)

Gets a relationship object from the set that represents a specified relationship.

Syntax

HRESULT GetRelationship(
  [in]          LPCWSTR          relationshipIdentifier,
  [out, retval] IOpcRelationship **relationship
);

[in] relationshipIdentifier

The unique identifier of a relationship.

[out, retval] relationship

A pointer to the IOpcRelationship interface of the relationship object that represents the relationship that has the specified identifier.

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 relationship parameter is NULL.
OPC_E_NO_SUCH_RELATIONSHIP 0x80510048	The specified relationship does not exist.
Package Consumption error	An HRESULT error code from the Package Consumption Error Group.
Part URI error	An HRESULT error code from the Part URI Error Group.

The IOpcRelationship interface provides access to relationship properties. For details about these properties, see the Relationships Overview and IOpcRelationship.

Packaging objects are not thread-safe.

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