ArchiveFileStreamContext Class

Microsoft Deployment Tools

Deployment Tools Foundation ArchiveFileStreamContext Class
Deployment Tools Foundation NamespacesMicrosoft.Deployment.CompressionArchiveFileStreamContext
Provides a basic implementation of the archive pack and unpack stream context interfaces, based on a list of archive files, a default directory, and an optional mapping from internal to external file paths.
Declaration Syntax
C# Visual Basic Visual C++
public class ArchiveFileStreamContext : IPackStreamContext, 
	IUnpackStreamContext
Public Class ArchiveFileStreamContext _
	Implements IPackStreamContext, IUnpackStreamContext
public ref class ArchiveFileStreamContext : IPackStreamContext, 
	IUnpackStreamContext
Members
All Members Constructors Methods Properties



Icon Member Description
ArchiveFileStreamContext(String)
Creates a new ArchiveFileStreamContext with a archive file and no default directory or file mapping.

ArchiveFileStreamContext(String, String, IDictionary<(Of <(String, String>)>))
Creates a new ArchiveFileStreamContext with a archive file, default directory and mapping from internal to external file paths.

ArchiveFileStreamContext(IList<(Of <(String>)>), String, IDictionary<(Of <(String, String>)>))
Creates a new ArchiveFileStreamContext with a list of archive files, a default directory and a mapping from internal to external file paths.

ArchiveFiles
Gets or sets the list of archive files that are created or extracted.

CloseArchiveReadStream(Int32, String, Stream)
Closes a stream where an archive was read.

CloseArchiveWriteStream(Int32, String, Stream)
Closes a stream where an archive package was written.

CloseFileReadStream(String, Stream)
Closes a stream that has been used to read a file.

CloseFileWriteStream(String, Stream, FileAttributes, DateTime)
Closes a stream where an extracted file was written.

Directory
Gets or sets the default root directory where files are located.

EnableOffsetOpen
Gets or sets a flag that enables creating or extracting an archive at an offset within an existing file. (This is typically used to open archive-based self-extracting packages.)

Equals(Object)
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
ExtractOnlyNewerFiles
Gets or sets a flag that can prevent extracted files from overwriting newer files that already exist.

Files
Gets or sets the mapping from internal file paths to external file paths.

Finalize()()()
Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
(Inherited from Object.)
GetArchiveName(Int32)
Gets the name of the archive with a specified number.

GetHashCode()()()
Serves as a hash function for a particular type. GetHashCode()()() is suitable for use in hashing algorithms and data structures like a hash table.
(Inherited from Object.)
GetOption(String, array<Object>[]()[])
Gets extended parameter information specific to the compression format being used.

GetType()()()
Gets the Type of the current instance.
(Inherited from Object.)
MemberwiseClone()()()
Creates a shallow copy of the current Object.
(Inherited from Object.)
OpenArchiveReadStream(Int32, String, CompressionEngine)
Opens the archive stream for reading.

OpenArchiveWriteStream(Int32, String, Boolean, CompressionEngine)
Opens a stream for writing an archive.

OpenFileReadStream(String, FileAttributes%, DateTime%)
Opens a stream to read a file that is to be included in an archive.

OpenFileWriteStream(String, Int64, DateTime)
Opens a stream for writing extracted file bytes.

ToString()()()
Returns a String that represents the current Object.
(Inherited from Object.)
Remarks
This class can also handle creating or extracting chained archive packages.
Inheritance Hierarchy
Object
ArchiveFileStreamContext

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