USTAR.WriteTar

Method Signatures

 Protected Function WriteTar(ToArchive() As FolderItem, OutputFile As FolderItem, Optional RelativeRoot As FolderItem, Overwrite As Boolean = False, CompressionLevel As Integer) As Boolean
 Protected Function WriteTar(RootDirectory As FolderItem, OutputFile As FolderItem, Overwrite As Boolean = False, CompressionLevel As Integer) As Boolean

Parameters

`WriteTar(FolderItem(), FolderItem, FolderItem, Boolean, Integer)`

Name	Type	Comment
ToArchive	FolderItem array	A list of files to be appended to the archive
OutputFile	FolderItem	The archive file to which files should be appended.
RelativeRoot	FolderItem	Optional. The 'root' of the archive (for generating relative paths)
Overwrite	Boolean	Optional. If `True` then the `Outputfile` is overwritten if it exists.
CompressionLevel	Integer	Optional. Specify a number between 1 and 9 to use gzip compression.

`WriteTar(FolderItem, FolderItem, Boolean, Integer)`

Name	Type	Comment
RootDirectory	FolderItem	A directory whose contents should be recursively added to the archive.
OutputFile	FolderItem	The archive file to which files should be appended.
Overwrite	Boolean	Optional. If `True` then the `Outputfile` is overwritten if it exists.
CompressionLevel	Integer	Optional. Specify a number between 1 and 9 to use gzip compression.

Return value

Returns True if the operation was successful.

Remarks

Creates a tape archive of theToArchive array and writes it to the OutputFile. If CompressionLevel is between 1 and 9 then gzip compression is used.