OpenArchiveReadStream Method (archiveNumber, archiveName, compressionEngine)

Microsoft Deployment Compression & Installer

previous page next page

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

Opens the archive stream for reading.

Declaration Syntax

Visual Basic

Visual C++

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

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

public:
virtual 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

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

Remarks

This method opens the file from the ArchiveFiles list with the specified index. If the archive number is outside the bounds of the list, this method returns null.

If the EnableOffsetOpen flag is set, this method will seek to the start of any existing archive in the file, or to the end of the file if the existing file is not an archive.

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

previous page start next page