IOpcRelationshipSet::RelationshipExists method (msopc.h)

Gets a value that indicates whether a specified relationship is represented as a relationship object in the set.

Syntax

HRESULT RelationshipExists(
  [in]          LPCWSTR relationshipIdentifier,
  [out, retval] BOOL    *relationshipExists
);

Parameters

[in] relationshipIdentifier

The unique identifier of a relationship.

[out, retval] relationshipExists

One of the following values:

Value Meaning
TRUE
A relationship that has the identifier specified in relationshipIdentifier is represented in the set.
FALSE
A relationship that has the identifier specified in relationshipIdentifier is not represented in the set.

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
At least one of the relationshipIdentifier and relationshipExists parameters 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

If a relationship is represented in the set, the relationship is stored in the Relationships part represented by that set.

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

Getting Started with the Packaging API

IOpcRelationshipSet

Overviews

Packaging API Reference

Packaging API Samples

Packaging Errors

Reference