GetTarContents(String,Boolean,Boolean,String[]) Method

Lists the items contained in the Tar archive, specifying whether the operation will be performed recursively and using the provided filters on the returned items.

Syntax

Visual Basic
C#

'Declaration
 
Public Overloads Shared Function GetTarContents( _
   ByVal tarFileName As String, _
   ByVal recursive As Boolean, _
   ByVal isTarCompressed As Boolean, _
   ByVal ParamArray filters() As String _
) As QuickTarItem()

'Usage
 
Dim tarFileName As String
Dim recursive As Boolean
Dim isTarCompressed As Boolean
Dim filters() As String
Dim value() As QuickTarItem
 
value = QuickTar.GetTarContents(tarFileName, recursive, isTarCompressed, filters)

public static QuickTarItem[] GetTarContents( 
   string tarFileName,
   bool recursive,
   bool isTarCompressed,
   params string[] filters
)

Parameters

tarFileName: The full path of the Tar archive. Cannot be empty and must exist.
recursive: Boolean value indicating whether files contained within sub-folders of filesToTar items should be listed.
isTarCompressed: Boolean value indicating if the tar file was compressed using GZip. Note: The GZip file retrieved must have the following format: tarFileName.gz. An exception is thrown if the Tar archive is not compressed.
filters: Used to filter the contents of the Tar archive.

Remarks

This implementation of Tar is fully read/write compatible with the USTAR format. It is read compatible with GNU Tar archives whose entries do not use the header extensions of this format.

Requirements

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

Reference

QuickTar Class
QuickTar Members
Overload List