Export (0) Print
Expand All

Package.Open Method (String, FileMode, FileAccess)

Opens a package at a given path using a given file mode and file access setting.

Namespace:  System.IO.Packaging
Assembly:  WindowsBase (in WindowsBase.dll)

public static Package Open(
	string path,
	FileMode packageMode,
	FileAccess packageAccess
)

Parameters

path
Type: System.String

The path and file name of the package.

packageMode
Type: System.IO.FileMode

The file mode in which to open the package.

packageAccess
Type: System.IO.FileAccess

The file access in which to open the package.

Return Value

Type: System.IO.Packaging.Package
The opened package.

ExceptionCondition
ArgumentNullException

path is null.

ArgumentOutOfRangeException

Value for packageMode or packageAccess is not valid.

ZipPackage is the default package type that is used by the Open method.

This Open method opens the package with a default None attribute (to specify a different attribute use the Open method overload).

For additional information, see the Open Packaging Conventions (OPC) specification available for download at http://go.microsoft.com/fwlink/?LinkID=71255.

The following example shows how to open and read a Package that contains PackageRelationship and PackagePart elements together with stored data. For the complete sample, see Reading a Package Sample.

// Open the Package. 
// ('using' statement insures that 'package' is 
//  closed and disposed when it goes out of scope.) 
using (Package package =
    Package.Open(packagePath, FileMode.Open, FileAccess.Read))
{
    PackagePart documentPart = null;
    PackagePart resourcePart = null;

    // Get the Package Relationships and look for 
    //   the Document part based on the RelationshipType
    Uri uriDocumentTarget = null;
    foreach (PackageRelationship relationship in
        package.GetRelationshipsByType(PackageRelationshipType))
    {
        // Resolve the Relationship Target Uri 
        //   so the Document Part can be retrieved.
        uriDocumentTarget = PackUriHelper.ResolvePartUri(
            new Uri("/", UriKind.Relative), relationship.TargetUri);

        // Open the Document Part, write the contents to a file.
        documentPart = package.GetPart(uriDocumentTarget);
        ExtractPart(documentPart, targetDirectory);
    }

    // Get the Document part's Relationships, 
    //   and look for required resources.
    Uri uriResourceTarget = null;
    foreach (PackageRelationship relationship in
        documentPart.GetRelationshipsByType(
                                ResourceRelationshipType))
    {
        // Resolve the Relationship Target Uri 
        //   so the Resource Part can be retrieved.
        uriResourceTarget = PackUriHelper.ResolvePartUri(
            documentPart.Uri, relationship.TargetUri);

        // Open the Resource Part and write the contents to a file.
        resourcePart = package.GetPart(uriResourceTarget);
        ExtractPart(resourcePart, targetDirectory);
    }

}// end:using(Package package) - Close & dispose package.

.NET Framework

Supported in: 4.6, 4.5, 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Show:
© 2014 Microsoft