IOpcPackage::GetRelationshipSet method

Gets a relationship set object that represents the Relationships part that stores package relationships.

Syntax


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

Parameters

relationshipSet [out, retval]

A pointer to the IOpcRelationshipSet interface of the relationship set object. The set represents the Relationships part that stores package relationships.

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 Package relationships represented in the set provide the entry point to a package for an application.

For more information about packages, parts, relationships, and the interfaces that represent them, 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

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

 

 

Community Additions

ADD
Show: