IOpcRelationshipSet::DeleteRelationship method (msopc.h)

Article
02/22/2024

Deletes a specified IOpcRelationship interface pointer from the set.

Syntax

HRESULT DeleteRelationship(
  [in] LPCWSTR relationshipIdentifier
);

Parameters

[in] relationshipIdentifier

The unique identifier of a relationship.

The IOpcRelationship interface pointer to be deleted is the pointer to the relationship object that represents the relationship the specified identifier.

Return value

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

Return code/value	Description
S_OK	The method succeeded.
E_POINTER	The relationshipIdentifier parameter is NULL.
OPC_E_NO_SUCH_RELATIONSHIP 0x80510048	The specified relationship does not exist.
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

When an IOpcRelationship interface pointer is deleted from the set, the relationship it represents is not saved when the package is saved.

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