SecureBlackbox Lite 2020 Android Edition

Questions / Feedback?

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

SecureBlackboxLite.Archivewriter

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.

ArchiveTypeThe type of the archive.
CompressionLevelThe compression level to apply to the archived data.
DecryptionCertificatesA collection of decryption certificates.
DecryptionPasswordThe decryption password.
EncryptionAlgorithmSpecifies the encryption algorithm to apply to the archive.
EncryptionCertificateThe encryption certificate.
EncryptionPasswordSpecifies the archive encryption password.
EncryptionTypeThe type of encryption to apply to the archive.
FileDataThe contents of the file being added to the archive.
FilesLists the contents of the archive.
FileStreamThe contents of the file being added to the archive, in a stream.
NewArchiveIndicates whether the archive object represents a new (rather than opened) archive.
OpenedIndicates whether component is currently in edit mode.
SigningCertificateThe certificate to be used for signing.
SigningChainThe 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.

addEmptyDirAdds an empty folder to the archive.
addFileAdds a file to the archive.
addFilesAdds a group of files to the archive.
addVirtualAdds a file placeholder to the archive.
closeCloses the archive.
configSets or retrieves a configuration setting.
createNewCreates a new archive.
openOpens an archive file.
openBytesLoads an archive file from a byte array.
openStreamLoads an archive file from a stream.
removeRemoves file(s) and/or folder(s) from the archive.
saveCompresses the archive and saves it to a file.
saveBytesCompresses the archive and saves it to a byte array.
saveStreamCompresses the archive and saves it to a stream.
updateFileUpdates an existing compressed entry with a fresher local version.
updateFilesUpdates a selection of files in the archive.
updateVirtualUpdates 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.

AfterCompressFileMarks the completion of compression of a file.
BeforeCompressFileMarks the start of compression of a file.
DecryptionPasswordNeededFires when the component needs a password to decrypt the archive.
ErrorReports information about errors during archive assembling.
NotificationThis event notifies the application about an underlying control flow event.
PrepareFileFires for every file to be compressed before the compression starts.
ProgressReports the progress of data compression.
RecipientFoundSignifies 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.

EncryptionKeyLengthThe length of the encryption key.
TempPathPath for storing temporary files.
UsePaxEnables use of PAX algorithm when creating TAR directories.
UseUStarEnables use of UStar variant of file name packaging when creating TAR directories.

Copyright (c) 2022 /n software inc. - All rights reserved.
SecureBlackbox Lite 2020 Android Edition - Version 20.0 [Build 8166]