This documentation is archived and is not being maintained.

PackagePart.GetStream Method (FileMode)

Returns the content stream opened in a specified I/O FileMode.

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

public Stream GetStream(
	FileMode mode
)
You cannot use methods in XAML.

Parameters

mode
Type: System.IO.FileMode

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

Return Value

Type: System.IO.Stream
The content stream of 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.

IOException

The mode parameter is not compatible with the package and part stream.

-or-

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

The FileAccess permissions of the returned content stream are the same as the permissions of the parent Package.

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.

Windows 7, Windows Vista, Windows XP SP2, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003

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

.NET Framework

Supported in: 3.5, 3.0
Show: