ArchiveFileStreamContext Constructor (archiveFiles, directory, files)

Microsoft Deployment Tools

previous page next page

Deployment Tools Foundation ArchiveFileStreamContext Constructor (archiveFiles, directory, files)

Creates a new ArchiveFileStreamContext with a list of archive files, a default directory and a mapping from internal to external file paths.

Declaration Syntax

Visual Basic

Visual C++

public ArchiveFileStreamContext(
	IList<string> archiveFiles,
	string directory,
	IDictionary<string, string> files
)

Public Sub New ( _
	archiveFiles As IList(Of String), _
	directory As String, _
	files As IDictionary(Of String, String) _
)

public:
ArchiveFileStreamContext(
	IList<String^>^ archiveFiles, 
	String^ directory, 
	IDictionary<String^, String^>^ files
)

Parameters

archiveFiles (IList<(Of <(String>)>)): A list of paths to archive files that will be created or extracted.

directory (String): The default root directory where files will be located, optional.

files (IDictionary<(Of <(String, String>)>)): A mapping from internal file paths to external file paths, optional.

Remarks

When creating chained archives, the archiveFiles list should include at least enough archives to handle the entire set of input files, based on the maximum archive size that is passed to the CompressionEngine.Pack(IPackStreamContext, IEnumerable<(Of <(String>)>), Int64).

If the mapping is not null and a file is not included in the mapping, the file will be skipped.

If the external path in the mapping is a simple file name or relative file path, it will be concatenated onto the default directory, if one was specified.

For more about how the default directory and files mapping are used, see OpenFileReadStream(String, FileAttributes%, DateTime%) and OpenFileWriteStream(String, Int64, DateTime).

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

previous page start next page