ArchiveWriter Component
Properties Methods Events Configuration Settings Errors
The ArchiveWriter component allows compressing, updating and modifying files for zip, tar, gzip and bzip2 archives.
Syntax
TsbiArchiveWriter
Remarks
Use ArchiveWriter to compress, update, and modify files in archives.
Property List
The following is the full list of the properties of the component with short descriptions. Click on the links for further details.
ArchiveType | The type of the archive. |
CompressionLevel | The compression level to apply to the archived data. |
DecryptionCertificates | A collection of decryption certificates. |
DecryptionPassword | The decryption password. |
EncryptionAlgorithm | Specifies the encryption algorithm to apply to the archive. |
EncryptionCertificate | The encryption certificate. |
EncryptionPassword | Specifies the archive encryption password. |
EncryptionType | The type of encryption to apply to the archive. |
FileData | The contents of the file being added to the archive. |
Files | Lists the contents of the archive. |
NewArchive | Indicates whether the archive object represents a new (rather than opened) archive. |
Opened | Indicates whether component is currently in edit mode. |
SigningCertificate | The certificate to be used for signing. |
SigningChain | The signing certificate chain. |
Method List
The following is the full list of the methods of the component with short descriptions. Click on the links for further details.
AddEmptyDir | Adds an empty folder to the archive. |
AddFile | Adds a file to the archive. |
AddFiles | Adds a group of files to the archive. |
AddVirtual | Adds a file placeholder to the archive. |
Close | Closes the archive. |
Config | Sets or retrieves a configuration setting. |
CreateNew | Creates a new archive. |
Open | Opens an archive file. |
OpenBytes | Loads an archive file from a byte array. |
OpenStream | Loads an archive file from a stream. |
Remove | Removes file(s) and/or folder(s) from the archive. |
Save | Compresses the archive and saves it to a file. |
SaveBytes | Compresses the archive and saves it to a byte array. |
SaveStream | Compresses the archive and saves it to a stream. |
UpdateFile | Updates an existing compressed entry with a fresher local version. |
UpdateFiles | Updates a selection of files in the archive. |
UpdateVirtual | Updates an entry in the archive with on-the-fly content. |
Event List
The following is the full list of the events fired by the component with short descriptions. Click on the links for further details.
AfterCompressFile | Marks the completion of compression of a file. |
BeforeCompressFile | Marks the start of compression of a file. |
DecryptionPasswordNeeded | Fires when the component needs a password to decrypt the archive. |
Error | Reports information about errors during archive assembling. |
Notification | This event notifies the application about an underlying control flow event. |
PrepareFile | Fires for every file to be compressed before the compression starts. |
Progress | Reports the progress of data compression. |
RecipientFound | Signifies that the archive was found to be encrypted with a digital certificate. |
Configuration Settings
The following is a list of configuration settings for the component with short descriptions. Click on the links for further details.
EncryptionKeyLength | The length of the encryption key. |
TempPath | Path for storing temporary files. |
UsePax | Enables use of PAX algorithm when creating TAR directories. |
UseUStar | Enables use of UStar variant of file name packaging when creating TAR directories. |