USTAR.TarReader

USTAR.TarReader

Class Declaration

 Protected Class TarReader

Remarks

This class reads a tape archive. To create a new instance pass a Readable object containing the archive to the Constructor method. The archive is processed one entry at a time, from the first entry to the last.

Create a new instance, and access the "Current*" properties to read metadata of the current item in the archive.

Call the MoveNext method to process the current item and then advance the selection to the next item in the archive. MoveNext will return True until an error occurs; note that this includes the end of the archive, so check LastError for details.

Example

This example extracts a single file from an archive:

  Dim tarfile As FolderItem = GetOpenFolderItem("")
  Dim ts As BinaryStream = BinaryStream.Open(tarfile)
  Dim tar As New USTAR.TarReader(ts)
  Dim outputfile As FolderItem = SpecialFolder.Desktop.Child("file.txt")
  Dim output As BinaryStream = BinaryStream.Create(outputfile)
  Do 
    If tar.CurrentName = "path/to/the/file.txt" Then
      Call tar.MoveNext(output)
      Exit Do
    End If
  Loop Until Not tar.MoveNext(Nil)
  output.Close
  tar.Close

Methods

• Close
• Constructor
• LastError
• MoveNext

Properties

• CurrentFileSize
• CurrentGroup
• CurrentMode
• CurrentModificationDate
• CurrentName
• CurrentOwner
• CurrentType