PackagePart.GetStream Method ()


Returns the part content data stream.

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

public Stream GetStream()

Return Value

Type: System.IO.Stream

The content data stream for the part.

Exception Condition

The part has been deleted.


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


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

This method opens the content stream with FileMode of OpenOrCreate and FileAccess permissions that are the same as the parent Package.

The overload GetStream method allows you to set a specific FileMode.

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