OpenArchiveReadStream Method (archiveNumber, archiveName, compressionEngine)

DTF API

Copy image CopyHover image
Deployment Tools Foundation OpenArchiveReadStream Method (archiveNumber, archiveName, compressionEngine)
Deployment Tools Foundation NamespacesMicrosoft.Deployment.CompressionBasicUnpackStreamContextOpenArchiveReadStream(Int32, String, CompressionEngine)
Opens the archive stream for reading. Returns a DuplicateStream instance, so the stream may be virtually opened multiple times.
Declaration Syntax
C# Visual Basic Visual C++ F#
public Stream OpenArchiveReadStream(
	int archiveNumber,
	string archiveName,
	CompressionEngine compressionEngine
)
Public Function OpenArchiveReadStream ( 
	archiveNumber As Integer,
	archiveName As String,
	compressionEngine As CompressionEngine
) As Stream
public:
virtual Stream^ OpenArchiveReadStream(
	int archiveNumber, 
	String^ archiveName, 
	CompressionEngine^ compressionEngine
) sealed
abstract OpenArchiveReadStream : 
        archiveNumber : int * 
        archiveName : string * 
        compressionEngine : CompressionEngine -> Stream 
override OpenArchiveReadStream : 
        archiveNumber : int * 
        archiveName : string * 
        compressionEngine : CompressionEngine -> Stream 
Parameters
archiveNumber (Int32)
The archive number to open (ignored; 0 is assumed).
archiveName (String)
The name of the archive being opened.
compressionEngine (CompressionEngine)
Instance of the compression engine doing the operations.
Return Value
Stream
A stream from which archive bytes are read.

Assembly: Microsoft.Deployment.Compression (Module: Microsoft.Deployment.Compression.dll) Version: 3.0.0.0 (3.11.1.2318)