Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

PackagePart.GetStream Method (FileMode, FileAccess)

Returns the part content stream opened with a specified FileMode and FileAccess.

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

public Stream GetStream(
	FileMode mode,
	FileAccess access
)

Parameters

mode
Type: System.IO.FileMode

The I/O mode in which to open the content stream.

access
Type: System.IO.FileAccess

The access permissions to use in opening the content stream.

Return Value

Type: System.IO.Stream
The content stream for the part.

ExceptionCondition
InvalidOperationException

The part has been deleted.

-or-

The Package is not open (Dispose or Close has been called).

ArgumentOutOfRangeException

The mode parameter is not a valid FileMode enumeration value.

-or-

The access parameter is not a valid FileAccess enumeration value.

IOException

mode or access is not compatible with the package and part stream.

-or-

The access parameter is specified as Read but the mode parameter requires write access. (FileMode values of Create, CreateNew, Truncate, and Append require Write or ReadWrite access.)

-or-

The stream object returned by the GetStreamCore method of the derived subclass is null.

Notes to Implementers

Notes to Callers

GetStream internally calls the derived GetStreamCore method to actually open and return the part data stream based on the physical format implemented in the derived class.

By default, the ZipPackagePart subclass implementation of the abstract PackagePart class is provided and used. In the default operation, GetStream internally calls GetStreamCore of the ZipPackagePart class to open and return the part data stream from a ZIP file.

.NET Framework

Supported in: 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