Platforms to show: All Mac Windows Linux Cross-Platform
ArchiveWriteDiskMBS class
Super class: ArchiveWriterMBS
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
class | Archive | MBS Compression Plugin | 19.0 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | All |
To create objects on disk:
1) Ask Constructor for a new ArchiveWriteDiskMBS object.
2) Set any global properties. In particular, you probably want to set the options.
3) For each entry: construct an appropriate ArchiveEntryMBS object, use WriteHeader to create the file/dir/etc on disk, use WriteData to write the entry data
4) Release object to cleanup the writer and release resources
In particular, you can use this in conjunction with ArchiveReaderMBS to pull entries out of an archive and create them on disk.
Subclass of the ArchiveWriterMBS class.
- 2 events
- event GroupLookup(Name as String, GID as Int64) as Int64
- event UserLookup(Name as String, GID as Int64) as Int64
- property Options as Integer
- 9 methods
- method Constructor
- method Destructor
- method GID(GroupName as string, DefaultGID as Int64) as Int64
- method SetSkipFile(DeviceID as Int64, FileNo as Int64)
- method SetStandardLookup
- method UID(UserName as string, DefaultUID as Int64) as Int64
- method WriteDataBlock(data as MemoryBlock, offset as Int64) as Int64
- method WriteDataBlock(data as Ptr, Size as Int64, offset as Int64) as Int64
- method WriteDataBlock(data as string, offset as Int64) as Int64
Super class ArchiveWriterMBS
- 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
This class has no sub classes.
Some examples using this class:
Blog Entries
Release notes
- Version 19.0
- Added ArchiveReadDiskMBS and ArchiveWriteDiskMBS classes to adding files to archives.
The items on this page are in the following plugins: MBS Compression Plugin.
ArchiverMBS - ArchiveWriterMBS