Xceed .NET Libraries Documentation
Tar(String,Boolean,Boolean,Boolean,String[]) Method


Xceed.Tar Assembly > Xceed.Tar Namespace > QuickTar Class > Tar Method : Tar(String,Boolean,Boolean,Boolean,String[]) Method
The full path of the Tar archive. Cannot be empty.
Boolean value indicating whether existing files should be replaced in the destination Tar archive.
Boolean value indicating whether files contained within sub-folders of filesToTar should be added to the Tar archive.
Boolean value indicating whether the directory structure should be preserved in the destination Tar archive.
The list of file paths to add to the Tar archive. Must contain at least one file.
Archives the specified files in the specified Tar archive, specifying whether existing files should be replaced and paths should be preserved, and whether the operation should be done recursively.
Syntax
'Declaration
 
Public Overloads Shared Sub Tar( _

   ByVal tarFileName As String, _

   ByVal replaceExistingFiles As Boolean, _

   ByVal recursive As Boolean, _

   ByVal preservePaths As Boolean, _

   ByVal ParamArray filesToTar() As String _

) 
'Usage
 
Dim tarFileName As String

Dim replaceExistingFiles As Boolean

Dim recursive As Boolean

Dim preservePaths As Boolean

Dim filesToTar() As String

 

QuickTar.Tar(tarFileName, replaceExistingFiles, recursive, preservePaths, filesToTar)
public static void Tar( 

   string tarFileName,

   bool replaceExistingFiles,

   bool recursive,

   bool preservePaths,

   params string[] filesToTar

)

Parameters

tarFileName
The full path of the Tar archive. Cannot be empty.
replaceExistingFiles
Boolean value indicating whether existing files should be replaced in the destination Tar archive.
recursive
Boolean value indicating whether files contained within sub-folders of filesToTar should be added to the Tar archive.
preservePaths
Boolean value indicating whether the directory structure should be preserved in the destination Tar archive.
filesToTar
The list of file paths to add to the Tar archive. Must contain at least one file.
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

See Also

Reference

QuickTar Class
QuickTar Members
Overload List