Platforms to show: All Mac Windows Linux Cross-Platform

ArchiveWriterMBS class

Super class: ArchiverMBS

Var a as new ArchiveWriterMBS

a.SetFormatZip
a.ZipSetCompressionDeflate

Var f as FolderItem = SpecialFolder.Desktop.Child("test.zip")
if not a.CreateFile(f) then
  break // failed
  
else
  
  Var data as string = "Hello World test file. Hello World again."
  
  Var e as new ArchiveEntryMBS
  e.PathName = "Hello World.txt"
  e.Size = lenb(data)
  e.Permissions = &o0644
  e.FileType = e.kFileTypeRegular
  
  a.WriteHeader e
  call a.WriteData data
  
  a.FinishEntry
  
  a.Close
end if

• 5 properties
  • property MemoryData as MemoryBlock
  • property MemoryPointer as Ptr
  • property MemorySize as Int64
  • property MemoryString as String
  • property WriteDataBlockSupported as Boolean
• 58 methods
  • method AddFilter(FilterCode as Integer)
  • method AddFilterB64encode
  • method AddFilterByName(Name as String)
  • method AddFilterBZip2
  • method AddFilterCompress
  • method AddFilterGRZip
  • method AddFilterGZip
  • method AddFilterLRZip
  • method AddFilterLZ4
  • method AddFilterLZip
  • method AddFilterLZMA
  • method AddFilterLZOp
  • method AddFilterNone
  • method AddFilterProgram(Command as String)
  • method AddFilterUUEncode
  • method AddFilterXZ
  • method Close
  • method Constructor
  • method CreateFile(File as FolderItem) as boolean
  • method CreateMemoryFile as boolean
  • method Destructor
  • method Fail
  • method FinishEntry
  • method SetFilterOption(Module as String, Option as String, Value as String)
  • method SetFormat(FormatCode as Integer)
  • method SetFormat7Zip
  • method SetFormatArBsd
  • method SetFormatArSvr4
  • method SetFormatByExtension(FileName as String, defaultExtension as String = "")
  • method SetFormatByName(Name as String)
  • method SetFormatCpio
  • method SetFormatCpioNewc
  • method SetFormatGnutar
  • method SetFormatIso9660
  • method SetFormatMTree
  • method SetFormatMTreeClassic
  • method SetFormatOption(Module as String, Option as String, Value as String)
  • method SetFormatPax
  • method SetFormatPaxRestricted
  • method SetFormatRaw
  • method SetFormatShar
  • method SetFormatSharDump
  • method SetFormatUstar
  • method SetFormatV7tar
  • method SetFormatWArc
  • method SetFormatXar
  • method SetFormatZip
  • method SetOption(Module as String, Option as String, Value as String)
  • method SetOptions(Options as String)
  • method SetPassphrase(Password as String)
  • method SetSkipFile(DeviceID as Int64, FileNo as Int64)
  • method WriteData(data as MemoryBlock) as Int64
  • method WriteData(data as Ptr, Size as Int64) as Int64
  • method WriteData(data as string) as Int64
  • method WriteData(SourceArchive as ArchiveReaderMBS) as Int64
  • method WriteHeader(Entry as ArchiveEntryMBS)
  • method ZipSetCompressionDeflate
  • method ZipSetCompressionStore

Super class ArchiverMBS

• event Passphrase(byref password as String) as Boolean
• 14 properties
  • property Compression as Integer
  • property CompressionName as String
  • property ErrNo as Integer
  • property ErrorString as String
  • property FileCount as Integer
  • property FilterCount as Integer
  • property Format as Integer
  • property FormatName as String
  • property Handle as Integer
  • property Lasterror as Integer
  • property Open as Boolean
  • property PositionCompressed as Int64
  • property PositionUncompressed as Int64
  • property Yield as Boolean
• 8 shared properties
  • shared property BZLibVersion as String
  • shared property LibVersion as Integer
  • shared property LibVersionDetails as String
  • shared property LibVersionString as String
  • shared property LZ4Version as String
  • shared property LzmaVersion as String
  • shared property ZLibVersion as String
  • shared property ZStdVersion as String
• 7 methods
  • method ClearError
  • method Constructor   Private
  • method CopyError(source as ArchiverMBS)
  • method Destructor
  • method FilterBytes(FilterIndex as Integer) as Int64
  • method FilterCode(FilterIndex as Integer) as Integer
  • method FilterName(FilterIndex as Integer) as String
• 5 shared methods
  • shared method LoadIconvLibrary(path as String, byref Error as String) as boolean
  • shared method NewReader as ArchiveReaderMBS
  • shared method NewWriter as ArchiveWriterMBS
  • shared method SetCurrentWorkingDirectory(path as folderitem) as boolean
  • shared method SetCurrentWorkingDirectory(path as String) as boolean
• 52 constants

Sub classes:

• class ArchiveWriteDiskMBS

Some methods using this class:

• ArchiverMBS.NewWriter as ArchiveWriterMBS

Some examples using this class:

• /Compression/Archive/archive
• /Compression/Archive/CreateArchive iOS
• /Compression/Archive/Write encrypted zip Archive
• /Compression/Archive/Write tar Archive
• /Compression/Archive/Write zip Archive

Blog Entries

• MBS Xojo Plugins, version 21.2pr5
• MBS Xojo Plugins, version 18.6pr3
• MBS Xojo / Real Studio Plugins, version 16.4pr2
• New Archive classes for handling zip and tar archives

Xojo Developer Magazine

• 19.4, page 81: Archives in Xojo, How to Use Zip Archives by Stefanie Juchmes

Release notes

• Version 21.2
  • Fixed ArchiveWriterMBS class to do AES256 encryption on Windows.
• Version 19.0
  • Added more methods to ArchiveWriterMBS, ArchiveReaderMBS and ArchiverMBS classes.

The items on this page are in the following plugins: MBS Compression Plugin.

ArchiveWriteDiskMBS   -   Argon2MBS