Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

IOpcRelationshipSet::GetRelationshipsContentStream method

Gets a read-only stream that contains the part content of the Relationships part represented by the set.

Syntax


HRESULT GetRelationshipsContentStream(
  [out, retval]  IStream **contents
);

Parameters

contents [out, retval]

A pointer to the IStream interface of the read-only stream that contains the part content of the Relationships part represented by the set.

If the relationships stored in the Relationships part have not been modified, part content can include markup compatibility data that is not otherwise accessible through the relationship objects in the set.

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

Calling this method will parse and validate all the relationships in the relationships markup. If the Relationships part contains invalid relationships markup, the markup cannot be retrieved by this method.

For more information about markup compatibility and packages, see Part 5: Markup Compatibility in ECMA-376 OpenXML (http://go.microsoft.com/fwlink/p/?linkid=123375).

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

IOpcRelationshipSet
Overviews
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:
© 2014 Microsoft. All rights reserved.