PackagePart.GetStream Method (FileMode)

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

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

member GetStream : 
        mode:FileMode -> Stream

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 a null reference (Nothing in Visual Basic).

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.

.NET Framework

Supported in: 4.5.2, 4.5.1, 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.

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft