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


Xceed.Tar Assembly > Xceed.Tar Namespace > QuickTar Class > Untar Method : Untar(String,String,Boolean,String[]) Method
The full path of the Tar archive. Cannot be empty.
The path to the destination folder in which to untar all items. Cannot be empty.
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.
The list of file paths to get from the Tar archive. Cannot be null.
Extracts files from a Tar archive to a destination folder, using the provide parameters and specifying whether the Tar archive is compressed with GZip.
Syntax
'Declaration
 
Public Overloads Shared Sub Untar( _

   ByVal tarFileName As String, _

   ByVal destinationFolder As String, _

   ByVal isTarCompressed As Boolean, _

   ByVal ParamArray filesToUntar() As String _

) 
'Usage
 
Dim tarFileName As String

Dim destinationFolder As String

Dim isTarCompressed As Boolean

Dim filesToUntar() As String

 

QuickTar.Untar(tarFileName, destinationFolder, isTarCompressed, filesToUntar)
public static void Untar( 

   string tarFileName,

   string destinationFolder,

   bool isTarCompressed,

   params string[] filesToUntar

)

Parameters

tarFileName
The full path of the Tar archive. Cannot be empty.
destinationFolder
The path to the destination folder in which to untar all items. Cannot be empty.
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.
filesToUntar
The list of file paths to get from the Tar archive. Cannot be null.
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