IOpcPart::GetRelationshipSet method (msopc.h)

Gets a relationship set object that represents the Relationships part that stores relationships that have the part as their source.

Syntax

HRESULT GetRelationshipSet(
  [out, retval] IOpcRelationshipSet **relationshipSet
);

Parameters

[out, retval] relationshipSet

A pointer to a relationship set object that represents the Relationships part that stores all relationships that have the part as their source.

Return value

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

Return code Description
S_OK
The method succeeded.
E_POINTER
The relationshipSet parameter is NULL.
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.

Remarks

The definitive way to find a part of interest is by using a relationship type to find the relationship that has the part of interest as its target. The target's URI can then be resolved to a part name which is used to access the part.

For more information about using the relationship type to find a relationship and then a part of interest, see IOpcRelationshipSet and IOpcRelationship.

For more information about parts and relationships, see the Open Packaging Conventions Fundamentals and the ECMA-376 OpenXML, 1st Edition, Part 2: Open Packaging Conventions (OPC).

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

ECMA-376 OpenXML

External Resources

Getting Started with the Packaging API

IOpcPart

Open Packaging Conventions Fundamentals

Overviews

Packaging API Reference

Packaging API Samples

Packaging Errors

Parts Overview

Reference

Relationships Overview