Skip to main content

CabInfo Class

Object representing a cabinet file on disk; provides access to file-based operations on the cabinet file.

Methods

MethodDescription
CreateCompressionEngine()Creates a compression engine that does the low-level work for this object.
GetFiles()Gets information about the files contained in the archive.
GetFiles(searchPattern)Gets information about the certain files contained in the archive file.

Remarks

Generally, the methods on this class are much easier to use than the stream-based interfaces provided by the «see T:WixToolset.Dtf.Compression.Cab.CabEngine» class. WixToolset.Dtf.Compression.Cab.dll version 5.0.0+41e11442b2ca93e444b60213b5ae99dcbab787d8

CreateCompressionEngine() Method

Creates a compression engine that does the low-level work for this object.

Declaration

protected WixToolset.Dtf.Compression.CompressionEngine CreateCompressionEngine()

Return value

WixToolset.Dtf.Compression.CompressionEngine A new «see T:WixToolset.Dtf.Compression.Cab.CabEngine» instance.

Remarks

Each instance will be «see M:WixToolset.Dtf.Compression.CompressionEngine.Dispose» d immediately after use.

GetFiles() Method

Gets information about the files contained in the archive.

Declaration

public IList<WixToolset.Dtf.Compression.Cab.CabFileInfo> GetFiles()

Return value

IList<WixToolset.Dtf.Compression.Cab.CabFileInfo> A list of «see T:WixToolset.Dtf.Compression.Cab.CabFileInfo» objects, each containing information about a file in the archive.

GetFiles(searchPattern) Method

Gets information about the certain files contained in the archive file.

Declaration

public IList<WixToolset.Dtf.Compression.Cab.CabFileInfo> GetFiles(
string searchPattern
)

Parameters

ParameterTypeDescription
searchPatternstringThe search string, such as "*.txt".

Return value

IList<WixToolset.Dtf.Compression.Cab.CabFileInfo> A list of «see T:WixToolset.Dtf.Compression.Cab.CabFileInfo» objects, each containing information about a file in the archive.