Xceed .NET Libraries Documentation
Untar(String,String,Boolean,Boolean,ByteProgressionCallback,ItemProgressionCallback,Object) Method


Xceed.Tar Assembly > Xceed.Tar Namespace > QuickTar Class > Untar Method : Untar(String,String,Boolean,Boolean,ByteProgressionCallback,ItemProgressionCallback,Object) 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 whether existing items in the destination should be replaced.
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.
Delegate for ByteProgression notification.
Delegate for ItemProgression notification.
Opaque data that will be passed back to the event handler when an event is raised.
Extracts files from a Tar archive to a destination folder, using the provided progression notification delegates, specifying whether existing files should be replaced and whether the Tar archive is compressed with GZip.
Syntax
'Declaration
 
Public Overloads Shared Sub Untar( _
   ByVal tarFileName As String, _
   ByVal destinationFolder As String, _
   ByVal replaceExistingFiles As Boolean, _
   ByVal isTarCompressed As Boolean, _
   ByVal byteProgressionCallback As QuickTar.ByteProgressionCallback, _
   ByVal itemProgressionCallback As QuickTar.ItemProgressionCallback, _
   ByVal userParams As Object _
) 
'Usage
 
Dim tarFileName As String
Dim destinationFolder As String
Dim replaceExistingFiles As Boolean
Dim isTarCompressed As Boolean
Dim byteProgressionCallback As QuickTar.ByteProgressionCallback
Dim itemProgressionCallback As QuickTar.ItemProgressionCallback
Dim userParams As Object
 
QuickTar.Untar(tarFileName, destinationFolder, replaceExistingFiles, isTarCompressed, byteProgressionCallback, itemProgressionCallback, userParams)

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.
replaceExistingFiles
Boolean value indicating whether existing items in the destination should be replaced.
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.
byteProgressionCallback
Delegate for ByteProgression notification.
itemProgressionCallback
Delegate for ItemProgression notification.
userParams
Opaque data that will be passed back to the event handler when an event is raised.
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