ArchiveReader Component
Properties Methods Events Configuration Settings Errors
The ArchiveReader component supports inspection and extraction of files from zip, tar, gzip and bzip2 archives.
Syntax
secureblackboxlite.Archivereader
Remarks
ArchiveReader shows and extracts archived files.
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 file. |
DecryptionCertificates | A collection of decryption certificates. |
DecryptionPassword | The decryption password. |
FileData | The contents of the last extracted file. |
Files | Lists all files contained in the archive. |
FileStream | The stream to extract the compressed file contents to. |
HashAlgorithm | Returns the hash algorithm that was used to generate the signature. |
KnownCertificates | A collection of certificates to be used for signature validation. |
Opened | Indicates if the component is in the open state. |
SignatureValidationResult | The signature validation result. |
SigningCertificate | The certificate of the signature creator. |
Method List
The following is the full list of the methods of the component with short descriptions. Click on the links for further details.
Close | Closes the current archive. |
Config | Sets or retrieves a configuration setting. |
Extract | Extracts a single file from the archive. |
ExtractAll | Extract all the files contained in the archive. |
Open | Opens an archive file. |
OpenBytes | Loads an archive file from a byte array. |
OpenStream | Loads an archive file from a stream. |
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.
AfterExtractFile | Marks the completion of extraction of an archived file. |
BeforeExtractFile | Marks the start of extraction of an archived file. |
DecryptionPasswordNeeded | Requests a decryption password, when needed. |
Error | Reports information about errors during archive processing. |
Notification | This event notifies the application about an underlying control flow event. |
Progress | Reports the progress of data extraction. |
RecipientFound | Informs the application that an archive is encrypted with a digital certificate. |
SignatureFound | Signifies the start of signature validation. |
Configuration Settings
The following is a list of configuration settings for the component with short descriptions. Click on the links for further details.
OverwriteExisting | Whether the component should overwrite existing files. |
TempPath | Path for storing temporary files. |