OpenArchiveReadStream Method (archiveNumber, archiveName, compressionEngine)

Microsoft Deployment Tools

Deployment Tools Foundation OpenArchiveReadStream Method (archiveNumber, archiveName, compressionEngine)

Opens the archive stream for reading.

Declaration Syntax

Visual Basic

Visual C++

Stream OpenArchiveReadStream(
	int archiveNumber,
	string archiveName,
	CompressionEngine compressionEngine
)

Function OpenArchiveReadStream ( _
	archiveNumber As Integer, _
	archiveName As String, _
	compressionEngine As CompressionEngine _
) As Stream

Stream^ OpenArchiveReadStream(
	int archiveNumber, 
	String^ archiveName, 
	CompressionEngine^ compressionEngine
)

Parameters

archiveNumber (Int32): The zero-based index of the archive to open.

archiveName (String): The name of the archive being opened.

compressionEngine (CompressionEngine): Instance of the compression engine doing the operations.

Return Value

A stream from which archive bytes are read, or null to cancel extraction of the archive.

Remarks

When the first archive in a chain is opened, the name is not yet known, so the provided value will be an empty string. When opening further archives, the provided value is the next-archive name stored in the previous archive. This name is often, but not necessarily, the same as the filename of the archive package to be opened.

If this method returns null, the archive engine will throw a FileNotFoundException.

Assembly: Microsoft.Deployment.Compression (Module: Microsoft.Deployment.Compression) Version: 3.0.0.0 (3.5.1623.0)

previous page start next page