Xceed .NET Libraries Documentation
Untar(AbstractFile,AbstractFolder,Boolean,Object[]) Method


Xceed.Tar Assembly > Xceed.Tar.Streaming Namespace > StreamingTar Class > Untar Method : Untar(AbstractFile,AbstractFolder,Boolean,Object[]) Method

An AbstractFile that specifies the Tar archive to extract. Cannot be null.

An AbstractFolder that specifies the destination folder in which to untar all items. Cannot be null.
Boolean value indicating whether existing items in the destination should be replaced.
An array of objects that can be used to filter the list of files extracted.

Recursively extracts all files from a Tar archive to a destination folder, using the provided progression notification delegates, specifying whether existing files should be replaced.

Syntax
'Declaration
 
Public Overloads Shared Sub Untar( _
   ByVal tarFile As AbstractFile, _
   ByVal destinationFolder As AbstractFolder, _
   ByVal replaceExistingFiles As Boolean, _
   ByVal ParamArray filters() As Object _
) 
'Usage
 
Dim tarFile As AbstractFile
Dim destinationFolder As AbstractFolder
Dim replaceExistingFiles As Boolean
Dim filters() As Object
 
StreamingTar.Untar(tarFile, destinationFolder, replaceExistingFiles, filters)
public static void Untar( 
   AbstractFile tarFile,
   AbstractFolder destinationFolder,
   bool replaceExistingFiles,
   params object[] filters
)

Parameters

tarFile

An AbstractFile that specifies the Tar archive to extract. Cannot be null.

destinationFolder
An AbstractFolder that specifies the destination folder in which to untar all items. Cannot be null.
replaceExistingFiles
Boolean value indicating whether existing items in the destination should be replaced.
filters
An array of objects that can be used to filter the list of files extracted.
Remarks

The archive is accessed in a streaming way and no preprocessing is done to gain knowledge of items, their location, and sizes for future updates to the archive.
As a result, extraction time is much lower than when using the other methods. Time gains between 40-55% are typical.

The directory structure is always preserved in the destination folder. All files and folder are extracted recursively.

In the event handlers, the current item will be null and the progression totals are not calculated.

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

StreamingTar Class
StreamingTar Members
Overload List