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
)

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.

Exception Condition
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.

.NET Framework
Available since 3.0
Return to top
Show: