Package.GetRelationships Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Returns a collection of all the package-level relationships.
public:
System::IO::Packaging::PackageRelationshipCollection ^ GetRelationships();public System.IO.Packaging.PackageRelationshipCollection GetRelationships ();member this.GetRelationships : unit -> System.IO.Packaging.PackageRelationshipCollectionPublic Function GetRelationships () As PackageRelationshipCollectionReturns
A collection of all the package-level relationships that are contained in the package.
Exceptions
The package is not open (Dispose(Boolean) or Close() has been called).
The package is write-only.
Remarks
GetRelationships will never return null; however the returned collection may contain zero elements if the package contains no package-level relationships.
A package-level relationship defines an association between the package and an associated target part or resource. A package-level relationship can be one of two forms.
- Between a Package to a target part in the package.
- Between a Package to a target resource outside the package.
In a package-relationship the package is considered the "owner" of the relationship. When the package is deleted, all the relationships owned by the package are also deleted. The process of creating or deleting the relationship does not physically alter the target part or resource in any way.
For additional information about packaging and package relationships, see section 1.3 of the Open Packaging Conventions (OPC) specification available for download at https://www.ecma-international.org/publications-and-standards/standards/ecma-376/.
