IOpcPart::GetRelationshipSet method

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

relationshipSet [out, retval]

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 codeDescription
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

Minimum supported client

Windows 7 [desktop apps only]

Minimum supported server

Windows Server 2008 R2 [desktop apps only]

Header

Msopc.h

IDL

Opcobjectmodel.idl

See also

IOpcPart
Overviews
Getting Started with the Packaging API
Open Packaging Conventions Fundamentals
Parts Overview
Relationships Overview
Reference
Packaging Errors
Packaging API Reference
Packaging API Samples
External Resources
ECMA-376 OpenXML

 

 

Community Additions

ADD
Show: