ArchiveWriter Component

Properties   Methods   Events   Config Settings   Errors  

The ArchiveWriter component allows compressing, updating and modifying files for zip, tar, gzip and bzip2 archives.

Syntax

TsbxArchiveWriter

Remarks

Use ArchiveWriter to compress, update, and modify files in archives.

 
 Copy
ArchiveWriter archiveWriter = new ArchiveWriter();

archiveWriter.setEncryptionType(ArchiveWriter.aetGeneric); // the type of encryption to apply to the archive
archiveWriter.setEncryptionPassword("MyPassword"); // specifies the archive encryption password

// creates a new archive with the desired archive type as a parameter
archiveWriter.createNew(ArchiveWriter.aftZip);

// add a file to the archive, the first parameter specifies the path where the file will be saved within the
// archive, the second parameter the file that you want to add to the archive
archiveWriter.addFile("","C:\\Photos\\MyPhoto.jpeg");

// add a collection of files to the archive, first param specifies the desired mount point for the files within the archive,
// second param is the path to the files on the local system, and the last one indicates whether you want to process the
// subdirectories recursively
archiveWriter.addFiles("","C:\\Photos",true);

archiveWriter.save("C:\\MyArchives");

The following common archive formats are supported:

• ZIP (.zip)
• GZip (.gz)
• BZip2 (.bz2)
• Tar+GZip (.tar.gz)
• Tar+Bzip2 (.tar.bz2)

Working with ArchiveWriter

Creating or opening the archive.

Use CreateNew to create a new archive, or one of the Open* methods (such as Open or OpenBytes) to open an existing compressed file.

Inspecting the archive contents

Use the Files collection to access information about individual files stored in the opened archive. On this stage you can adjust the individual files objects' > and > properties to configure bespoke processing for specific files.

Adding files to the archive

ArchiveWriter offers the following methods that you can use to add elements to the archive:

• AddFile - adds an entry with the contents of a local file.
• AddFiles - adds a set of files from a local directory.
• AddVirtual - allocates an entry in the archive. The actual data can be provided later using PrepareFile and BeforeCompressFile events.

Updating files in the archive

You can update files already present in the archive (e.g. with newer copies) using UpdateFile and UpdateFiles methods. The Remove method lets you delete individual files from the archive.

Use DecryptionPassword property to specify a decryption password for an archive and/or a specific entry within it. If the password is required but wasn't set, or if the provided password is wrong, the component will fire the DecryptionPasswordNeeded event. This event is fired repeatedly until the correct password is provided or its Cancel parameter is returned as true.

Saving and closing the archive

Once you are finished with composing/editing the archive, call the component's Save (or SaveBytes) method to save the updated archive, and then Close to close the archive file and release the associated memory.

Property List

The following is the full list of the properties of the component with short descriptions. Click on the links for further details.

Method List

The following is the full list of the methods of the component with short descriptions. Click on the links for further details.

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.

Config Settings

The following is a list of config settings for the component with short descriptions. Click on the links for further details.

ArchiveType Property (ArchiveWriter Component)

The type of the archive.

Syntax

__property TsbxArchiveWriterArchiveTypes ArchiveType = { read=FArchiveType };

enum TsbxArchiveWriterArchiveTypes {
  aftUnknown=0,
  aftZip=1,
  aftGzip=2,
  aftBzip2=3,
  aftTar=4,
  aftTarGzip=5,
  aftTarBzip2=6,
  aftSFX=7
};

Default Value

aftUnknown

Remarks

This property indicates the type of the opened archive.

This property is read-only.

Data Type

Integer

CompressionAlgorithm Property (ArchiveWriter Component)

Specifies the compression algorithm to use when forming the ZIP archive.

Syntax

__property int CompressionAlgorithm = { read=FCompressionAlgorithm, write=FSetCompressionAlgorithm };

Default Value

8

Remarks

Use this property to select the compression algorithm to be used when creating a ZIP archive.

A typical choice is DEFLATE, which is the default setting. Some implementations also use STORED as an alternative where no compression is required (so the resulting archive is effectively an uncompressed directory of files).

Data Type

Integer

CompressionLevel Property (ArchiveWriter Component)

The compression level to apply to the archived data.

Syntax

__property int CompressionLevel = { read=FCompressionLevel, write=FSetCompressionLevel };

Default Value

6

Remarks

Use this property to specify the compression level (1 to 9) to apply to the archived data.

Data Type

Integer

DecryptionCertCount Property (ArchiveWriter Component)

The number of records in the DecryptionCert arrays.

Syntax

__property int DecryptionCertCount = { read=FDecryptionCertCount, write=FSetDecryptionCertCount };

Default Value

0

Remarks

This property controls the size of the following arrays:

• DecryptionCertBytes
• DecryptionCertHandle

The array indices start at 0 and end at DecryptionCertCount - 1.

This property is not available at design time.

Data Type

Integer

DecryptionCertBytes Property (ArchiveWriter Component)

Returns the raw certificate data in DER format.

Syntax

__property DynamicArray DecryptionCertBytes[int DecryptionCertIndex] = { read=FDecryptionCertBytes };

Remarks

Returns the raw certificate data in DER format.

The DecryptionCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the DecryptionCertCount property.

This property is read-only and not available at design time.

Data Type

Byte Array

DecryptionCertHandle Property (ArchiveWriter Component)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

__property __int64 DecryptionCertHandle[int DecryptionCertIndex] = { read=FDecryptionCertHandle, write=FSetDecryptionCertHandle };

Default Value

0

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation.

 
 Copy
  pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

The DecryptionCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the DecryptionCertCount property.

This property is not available at design time.

Data Type

Long64

DecryptionPassword Property (ArchiveWriter Component)

The decryption password.

Syntax

__property String DecryptionPassword = { read=FDecryptionPassword, write=FSetDecryptionPassword };

Default Value

""

Remarks

Use this property to provide the decryption password. You can assign it explicitly before commencing file extraction, or provide it on the fly from DecryptionPasswordNeeded event handler.

Data Type

String

EncryptionAlgorithm Property (ArchiveWriter Component)

Specifies the encryption algorithm to apply to the archive.

Syntax

__property String EncryptionAlgorithm = { read=FEncryptionAlgorithm, write=FSetEncryptionAlgorithm };

Default Value

""

Remarks

Use this property to specify the encryption algorithm to apply to the archive.

Component supports the following algorithms: AES128, AES192, AES256, BLOWFISH, TWOFISH, 3DES, 3DES112, DES, RC2, RC4. Note that not all of them may be supported by the processing software.

Data Type

String

EncryptionCertBytes Property (ArchiveWriter Component)

Returns the raw certificate data in DER format.

Syntax

__property DynamicArray EncryptionCertBytes = { read=FEncryptionCertBytes };

Remarks

Returns the raw certificate data in DER format.

The parameter specifies the index of the item in the array. The size of the array is controlled by the EncryptionCertCount property.

This property is read-only and not available at design time.

Data Type

Byte Array

EncryptionCertHandle Property (ArchiveWriter Component)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

__property __int64 EncryptionCertHandle = { read=FEncryptionCertHandle, write=FSetEncryptionCertHandle };

Default Value

0

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation.

 
 Copy
  pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

The parameter specifies the index of the item in the array. The size of the array is controlled by the EncryptionCertCount property.

This property is not available at design time.

Data Type

Long64

EncryptionKeyLength Property (ArchiveWriter Component)

The length of the encryption key.

Syntax

__property int EncryptionKeyLength = { read=FEncryptionKeyLength, write=FSetEncryptionKeyLength };

Default Value

0

Remarks

Use this setting to specify the length of the encryption key in bits. Keep the key length at zero to let the component use the default value assumed by the encryption algorithm.

Data Type

Integer

EncryptionPassword Property (ArchiveWriter Component)

Specifies the archive encryption password.

Syntax

__property String EncryptionPassword = { read=FEncryptionPassword, write=FSetEncryptionPassword };

Default Value

""

Remarks

Use this property to provide the password to encrypt the archive with. Use it alongside EncryptionType and EncryptionAlgorithm properties to set up the whole set of protection settings for the archive.

Data Type

String

EncryptionType Property (ArchiveWriter Component)

The type of encryption to apply to the archive.

Syntax

__property TsbxArchiveWriterEncryptionTypes EncryptionType = { read=FEncryptionType, write=FSetEncryptionType };

enum TsbxArchiveWriterEncryptionTypes {
  aetDefault=0,
  aetNoEncryption=1,
  aetGeneric=2,
  aetWinZip=3,
  aetStrong=4
};

Default Value

aetDefault

Remarks

Specifies the encryption type for the archive.

Data Type

Integer

FileData Property (ArchiveWriter Component)

The contents of the file being added to the archive.

Syntax

__property DynamicArray FileData = { read=FFileData, write=FSetFileData };

Remarks

Assign this property with a byte array containing the contents of the file being added, if you set the corresponding entry's DataSource to fdsBuffer.

Use FileStream property, with DataSource set to fdsStream, to provide the data in a stream instead. Alternatively, use fdsFile data source to supply the file data in a disk file.

This property is not available at design time.

Data Type

Byte Array

FileCount Property (ArchiveWriter Component)

The number of records in the File arrays.

Syntax

__property int FileCount = { read=FFileCount, write=FSetFileCount };

Default Value

0

Remarks

This property controls the size of the following arrays:

• FileAction
• FileAttributes
• FileCompressedSize
• FileDataSource
• FileDirectory
• FileEncryptionAlgorithm
• FileEncryptionKeyLength
• FileEncryptionType
• FileFileName
• FileFolder
• FileLocalPath
• FileMTime
• FileNewFile
• FilePath
• FileSignatureCount
• FileSigned
• FileSize

The array indices start at 0 and end at FileCount - 1.

This property is not available at design time.

Data Type

Integer

FileAction Property (ArchiveWriter Component)

This property contains the action to apply to the file.

Syntax

__property TsbxArchiveWriterFileActions FileAction[int FileIndex] = { read=FFileAction, write=FSetFileAction };

enum TsbxArchiveWriterFileActions {
  atAdd=0,
  atKeep=1,
  atUpdate=2,
  atDelete=3,
  atExtract=4,
  atSkip=5
};

Default Value

atAdd

Remarks

This property contains the action to apply to the file.

Use this property to control the action that should be applied to the file during the compression or extraction. The following actions are supported:

The FileIndex parameter specifies the index of the item in the array. The size of the array is controlled by the FileCount property.

This property is not available at design time.

Data Type

Integer

FileAttributes Property (ArchiveWriter Component)

This property provides access to file attributes.

Syntax

__property String FileAttributes[int FileIndex] = { read=FFileAttributes, write=FSetFileAttributes };

Default Value

""

Remarks

This property provides access to file attributes.

ZIP archives support the provision of Windows (or DOS, as it is called historically) or Unix file attributes. Use this property to provide access to the attributes or to read them out of an existing archive.

Use "dos:" or "unix:" prefixes to indicate what kind of attributes you need to include, as follows:

 
 Copy
  Writer.Files[0].Attributes = "unix:-rwxr-xr-x";
  Writer.Files[1].Attributes = "unix:-r--r--r--";

  Writer.Files[2].Attributes = "dos:readonly";
  Writer.Files[3].Attributes = "dos:readonly;hidden"; // supported values: readonly, hidden, system, volumeLabel, directory, archive

The FileIndex parameter specifies the index of the item in the array. The size of the array is controlled by the FileCount property.

This property is not available at design time.

Data Type

String

FileCompressedSize Property (ArchiveWriter Component)

This property contains the size of the file after compression.

Syntax

__property __int64 FileCompressedSize[int FileIndex] = { read=FFileCompressedSize };

Default Value

0

Remarks

This property contains the size of the file after compression.

The FileIndex parameter specifies the index of the item in the array. The size of the array is controlled by the FileCount property.

This property is read-only and not available at design time.

Data Type

Long64

FileDataSource Property (ArchiveWriter Component)

This property contains the type of data source for this entry.

Syntax

__property TsbxArchiveWriterFileDataSources FileDataSource[int FileIndex] = { read=FFileDataSource, write=FSetFileDataSource };

enum TsbxArchiveWriterFileDataSources {
  fdsFile=0,
  fdsStream=1,
  fdsBuffer=2
};

Default Value

fdsFile

Remarks

This property contains the type of data source for this entry.

Use this property to control the data source for this entry.

The FileIndex parameter specifies the index of the item in the array. The size of the array is controlled by the FileCount property.

This property is not available at design time.

Data Type

Integer

FileDirectory Property (ArchiveWriter Component)

This property tells if the entry is a directory or a regular file.

Syntax

__property bool FileDirectory[int FileIndex] = { read=FFileDirectory };

Default Value

false

Remarks

This property tells if the entry is a directory or a regular file.

The FileIndex parameter specifies the index of the item in the array. The size of the array is controlled by the FileCount property.

This property is read-only and not available at design time.

Data Type

Boolean

FileEncryptionAlgorithm Property (ArchiveWriter Component)

This property returns the symmetric algorithm that was used to encrypt the file.

Syntax

__property String FileEncryptionAlgorithm[int FileIndex] = { read=FFileEncryptionAlgorithm };

Default Value

""

Remarks

This property returns the symmetric algorithm that was used to encrypt the file.

The FileIndex parameter specifies the index of the item in the array. The size of the array is controlled by the FileCount property.

This property is read-only and not available at design time.

Data Type

String

FileEncryptionKeyLength Property (ArchiveWriter Component)

This property returns the length, in bits, of the encryption key.

Syntax

__property int FileEncryptionKeyLength[int FileIndex] = { read=FFileEncryptionKeyLength };

Default Value

0

Remarks

This property returns the length, in bits, of the encryption key.

The FileIndex parameter specifies the index of the item in the array. The size of the array is controlled by the FileCount property.

This property is read-only and not available at design time.

Data Type

Integer

FileEncryptionType Property (ArchiveWriter Component)

This property contains the type of encryption applied to the file.

Syntax

__property TsbxArchiveWriterFileEncryptionTypes FileEncryptionType[int FileIndex] = { read=FFileEncryptionType };

enum TsbxArchiveWriterFileEncryptionTypes {
  aetDefault=0,
  aetNoEncryption=1,
  aetGeneric=2,
  aetWinZip=3,
  aetStrong=4
};

Default Value

aetDefault

Remarks

This property contains the type of encryption applied to the file.

Use this property to find out what kind of encryption was applied to the file.

The FileIndex parameter specifies the index of the item in the array. The size of the array is controlled by the FileCount property.

This property is read-only and not available at design time.

Data Type

Integer

FileFileName Property (ArchiveWriter Component)

This property specifies the original name of the compressed file or folder.

Syntax

__property String FileFileName[int FileIndex] = { read=FFileFileName, write=FSetFileFileName };

Default Value

""

Remarks

This property specifies the original name of the compressed file or folder.

The FileIndex parameter specifies the index of the item in the array. The size of the array is controlled by the FileCount property.

This property is not available at design time.

Data Type

String

FileFolder Property (ArchiveWriter Component)

This property includes the containing folder of the entry.

Syntax

__property String FileFolder[int FileIndex] = { read=FFileFolder };

Default Value

""

Remarks

This property includes the containing folder of the entry.

The FileIndex parameter specifies the index of the item in the array. The size of the array is controlled by the FileCount property.

This property is read-only and not available at design time.

Data Type

String

FileLocalPath Property (ArchiveWriter Component)

This property contains the local path associated with this entry.

Syntax

__property String FileLocalPath[int FileIndex] = { read=FFileLocalPath, write=FSetFileLocalPath };

Default Value

""

Remarks

This property contains the local path associated with this entry.

It typically specifies the source path that the data should be taken from, or the destination it should be extracted to.

The FileIndex parameter specifies the index of the item in the array. The size of the array is controlled by the FileCount property.

This property is not available at design time.

Data Type

String

FileMTime Property (ArchiveWriter Component)

This property contains the entry's last modification time.

Syntax

__property String FileMTime[int FileIndex] = { read=FFileMTime, write=FSetFileMTime };

Default Value

""

Remarks

This property contains the entry's last modification time.

The FileIndex parameter specifies the index of the item in the array. The size of the array is controlled by the FileCount property.

This property is not available at design time.

Data Type

String

FileNewFile Property (ArchiveWriter Component)

This property indicates whether the entry corresponds to a file to be added to the archive.

Syntax

__property bool FileNewFile[int FileIndex] = { read=FFileNewFile };

Default Value

false

Remarks

This property indicates whether the entry corresponds to a file to be added to the archive.

The FileIndex parameter specifies the index of the item in the array. The size of the array is controlled by the FileCount property.

This property is read-only and not available at design time.

Data Type

Boolean

FilePath Property (ArchiveWriter Component)

This property contains the full internal path of the archived entry.

Syntax

__property String FilePath[int FileIndex] = { read=FFilePath };

Default Value

""

Remarks

This property contains the full internal path of the archived entry.

The FileIndex parameter specifies the index of the item in the array. The size of the array is controlled by the FileCount property.

This property is read-only and not available at design time.

Data Type

String

FileSignatureCount Property (ArchiveWriter Component)

This property includes the number of signatures covering the entry.

Syntax

__property int FileSignatureCount[int FileIndex] = { read=FFileSignatureCount };

Default Value

0

Remarks

This property includes the number of signatures covering the entry.

The FileIndex parameter specifies the index of the item in the array. The size of the array is controlled by the FileCount property.

This property is read-only and not available at design time.

Data Type

Integer

FileSigned Property (ArchiveWriter Component)

This property indicates whether the entry is signed.

Syntax

__property bool FileSigned[int FileIndex] = { read=FFileSigned };

Default Value

false

Remarks

This property indicates whether the entry is signed.

The FileIndex parameter specifies the index of the item in the array. The size of the array is controlled by the FileCount property.

This property is read-only and not available at design time.

Data Type

Boolean

FileSize Property (ArchiveWriter Component)

This property specifies the size of the file before compression.

Syntax

__property __int64 FileSize[int FileIndex] = { read=FFileSize };

Default Value

0

Remarks

This property specifies the size of the file before compression.

The FileIndex parameter specifies the index of the item in the array. The size of the array is controlled by the FileCount property.

This property is read-only and not available at design time.

Data Type

Long64

FIPSMode Property (ArchiveWriter Component)

Reserved.

Syntax

__property bool FIPSMode = { read=FFIPSMode, write=FSetFIPSMode };

Default Value

false

Remarks

This property is reserved for future use.

Data Type

Boolean

HashAlgorithm Property (ArchiveWriter Component)

Specifies the hash algorithm to be used to generate the signature.

Syntax

__property String HashAlgorithm = { read=FHashAlgorithm, write=FSetHashAlgorithm };

Default Value

""

Remarks

Set this property before signing the archive to specify the hash algorithm to be used to calculate the signature.

This property is not available at design time.

Data Type

String

NewArchive Property (ArchiveWriter Component)

Indicates whether the archive object represents a new (rather than opened) archive.

Syntax

__property bool NewArchive = { read=FNewArchive };

Default Value

false

Remarks

This property is set to true if the archive is new, or to false if the component control is editing an existing archive.

NewArchive would typically be set to true after a CreateNew call, and to false after an Open call.

This property is read-only.

Data Type

Boolean

Opened Property (ArchiveWriter Component)

Indicates whether component is currently in edit mode.

Syntax

__property bool Opened = { read=FOpened };

Default Value

false

Remarks

This property is set to true if the archive control is in edit mode, meaning it was opened with Open or created with CreateNew call.

When an archive is opened, you can add new files to it, remove existing files, or modify encryption attributes.

This property is read-only.

Data Type

Boolean

Overwrite Property (ArchiveWriter Component)

Whether the component should overwrite existing files.

Syntax

__property bool Overwrite = { read=FOverwrite, write=FSetOverwrite };

Default Value

false

Remarks

Enable this property to force overwriting of existing files.

Data Type

Boolean

SigningCertBytes Property (ArchiveWriter Component)

Returns the raw certificate data in DER format.

Syntax

__property DynamicArray SigningCertBytes = { read=FSigningCertBytes };

Remarks

Returns the raw certificate data in DER format.

This property is read-only and not available at design time.

Data Type

Byte Array

SigningCertHandle Property (ArchiveWriter Component)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

__property __int64 SigningCertHandle = { read=FSigningCertHandle, write=FSetSigningCertHandle };

Default Value

0

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation.

 
 Copy
  pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

This property is not available at design time.

Data Type

Long64

SigningChainCount Property (ArchiveWriter Component)

The number of records in the SigningChain arrays.

Syntax

__property int SigningChainCount = { read=FSigningChainCount, write=FSetSigningChainCount };

Default Value

0

Remarks

This property controls the size of the following arrays:

• SigningChainBytes
• SigningChainHandle

The array indices start at 0 and end at SigningChainCount - 1.

This property is not available at design time.

Data Type

Integer

SigningChainBytes Property (ArchiveWriter Component)

Returns the raw certificate data in DER format.

Syntax

__property DynamicArray SigningChainBytes[int SigningChainIndex] = { read=FSigningChainBytes };

Remarks

Returns the raw certificate data in DER format.

The SigningChainIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SigningChainCount property.

This property is read-only and not available at design time.

Data Type

Byte Array

SigningChainHandle Property (ArchiveWriter Component)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

__property __int64 SigningChainHandle[int SigningChainIndex] = { read=FSigningChainHandle, write=FSetSigningChainHandle };

Default Value

0

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation.

 
 Copy
  pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

The SigningChainIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SigningChainCount property.

This property is not available at design time.

Data Type

Long64

AddEmptyDir Method (ArchiveWriter Component)

Adds an empty folder to the archive.

Syntax

int __fastcall AddEmptyDir(String Path);

Remarks

Use this method to added an empty folder to the archive with an internal path of Path.

The method returns the index of the new folder entry in the Files collection.

AddFile Method (ArchiveWriter Component)

Adds a file to the archive.

Syntax

int __fastcall AddFile(String Path, String LocalPath);

Remarks

Use this method to add a disk file to the archive. Provide the local path to the file (e.g. C:\Photos\photo.jpg) via the LocalPath parameter, and the desired path within the archive (e.g. PhotosBackup2020/photo.jpg) via the Path parameter.

AddFiles Method (ArchiveWriter Component)

Adds a group of files to the archive.

Syntax

void __fastcall AddFiles(String Folder, String LocalPath, bool Recursive);

Remarks

Use this method to add a collection of files to the archive.

Provide the path to the files on a local system (e.g. C:\photos) via the LocalPath parameter, and set Recursive to indicate whether you want to process the subdirectories recursively. Pass the desired mount point for the files within the archive (e.g. Backup2020/photos) via the Folder parameter.

You can use file mask wildcards in LocalPath to only select the files that match the mask.

AddVirtual Method (ArchiveWriter Component)

Adds a file placeholder to the archive.

Syntax

int __fastcall AddVirtual(String Path);

Remarks

Use this method to add a placeholder for the entry the contents of which is to be provided on the fly from a stream or buffer.

Pass the path to the entry within the archive (e.g. Reports/report2020.csv) via the Path parameter. After the entry has been added, use PrepareFile event or Files property to tune up the type of the data source (file, stream, or memory buffer). During the actual compression, provide the contents of the entry in a stream or buffer in the BeforeCompressFile event handler.

This method returns the index of the new entry in the Files collection.

Close Method (ArchiveWriter Component)

Closes the archive.

Syntax

void __fastcall Close();

Remarks

Use this method to close the current archive and dispose of all the allocated resources.

Call this method when you are done with the archive.

Config Method (ArchiveWriter Component)

Sets or retrieves a configuration setting.

Syntax

String __fastcall Config(String ConfigurationString);

Remarks

Config is a generic method available in every component. It is used to set and retrieve configuration settings for the component.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

CreateNew Method (ArchiveWriter Component)

Creates a new archive.

Syntax

void __fastcall CreateNew(int ArchiveType);

Remarks

Use this method to create a new archive file. Provide the desired archive type in the ArchiveType parameter.

The following archive types are currently supported:

The archive will be kept in memory until written down with Save or SaveStream method.

DoAction Method (ArchiveWriter Component)

Performs an additional action.

Syntax

String __fastcall DoAction(String ActionID, String ActionParams);

Remarks

DoAction is a generic method available in every component. It is used to perform an additional action introduced after the product major release. The list of actions is not fixed, and may be flexibly extended over time.

The unique identifier (case insensitive) of the action is provided in the ActionID parameter.

ActionParams contains the value of a single parameter, or a list of multiple parameters for the action in the form of PARAM1=VALUE1;PARAM2=VALUE2;....

Common ActionIDs:

Open Method (ArchiveWriter Component)

Opens an archive file.

Syntax

void __fastcall Open(int ArchiveType, String ArchiveName);

Remarks

Use this method to open an existing archive file for modification.

Provide the path to the archive file via the ArchiveName parameter, and pass the archive type in the ArchiveType parameter.

The following archive types are currently supported:

The archive will be kept in memory until written down with Save or SaveStream method.

OpenBytes Method (ArchiveWriter Component)

Loads an archive file from a byte array.

Syntax

void __fastcall OpenBytes(int ArchiveType, DynamicArray<Byte> ArchiveBytes);

Remarks

Use this method to load an existing archive file from a byte array.

Provide the archive stream via the ArchiveBytes parameter, and pass the archive type in the ArchiveType parameter.

The following archive types are currently supported:

The archive will be kept in memory until written down with Save, SaveStream, or SaveBytes method.

Remove Method (ArchiveWriter Component)

Removes file(s) and/or folder(s) from the archive.

Syntax

void __fastcall Remove(String Path);

Remarks

Use this method to remove entries from the archive. Provide an archive-local path via the Path parameter.

Path supports file masks, which makes this method quite powerful (and potentially dangerous).

Reset Method (ArchiveWriter Component)

Resets the component settings.

Syntax

void __fastcall Reset();

Remarks

Reset is a generic method available in every component.

Save Method (ArchiveWriter Component)

Compresses the archive and saves it to a file.

Syntax

void __fastcall Save(String ArchiveName);

Remarks

Use this method to finalize all preparations, compress all the entries set up in Files collection, and write the created archive to ArchiveName file.

This method carries out a lot of work and fires a number of events during its execution. Before the compression process starts, PrepareFile event fires repeatedly to provide the summary of what is being included into the archive. A handler of that event is a good place to make last-minute modifications to the data sources, file names, and actions to take upon the files.

Compression of each entry is surrounded with BeforeCompressFile and AfterCompressFile "brackets". Subscribe to BeforeCompressFile to supply the file contents for entries with Buffer and Stream data sources. AfterCompressFile is a good place to release the content stream alloated in the BeforeCompressFile event handler.

Progress event fires repeatedly to report the progress of the current and whole operations. It also provides an opportunity to abort the compression process.

SaveBytes Method (ArchiveWriter Component)

Compresses the archive and saves it to a byte array.

Syntax

DynamicArray<Byte> __fastcall SaveBytes();

Remarks

Use this method to finalize all preparations and compress all entries contained in the Files collection. The method returns the byte array containing the serialized archive.

You can fine-tune the compression process by providing compression details on the fly via the events component fires. See the description of the Save method for the details.

UpdateFile Method (ArchiveWriter Component)

Updates an existing compressed entry with a fresher local version.

Syntax

void __fastcall UpdateFile(String Path, String LocalPath);

Remarks

Call this method to update the Path entry in the archive with a fresher entry at LocalPath.

UpdateFiles Method (ArchiveWriter Component)

Updates a selection of files in the archive.

Syntax

void __fastcall UpdateFiles(String Folder, String LocalPath, bool AddMissingFiles, bool RemoveMissingFiles, bool Recursive);

Remarks

This method is a powerful way to update a subset of files in the archive in accordance with a specified criteria.

Pass an archive-local name of the folder to update via the Folder parameter, and the system-local version of the same folder via the LocalPath parameter. Set AddMissingFiles and RemoveMissingFiles as needed to force inclusion of files missing from the archive, or removal of files missing locally, accordingly.

The Recursive parameter specifies whether the directory should be browsed recursively.

UpdateVirtual Method (ArchiveWriter Component)

Updates an entry in the archive with on-the-fly content.

Syntax

void __fastcall UpdateVirtual(String Path);

Remarks

Use this method to update content of an existing archive entry. Pass the archive-local entry path via the Path parameter. After updating the entry, tune up its DataSource property in accordance with the desired content origin. Subscribe to BeforeCompressFile to supply the actual data via FileData or FileStream properties.

ActionNeeded Event (ArchiveWriter Component)

Requests a decision from the application in case of a conflict.

Syntax

typedef struct {
  int WhatFor;
  String EntryPath;
  String DestPath;
  String Description;
  int Action;
} TsbxArchiveWriterActionNeededEventParams;
typedef void __fastcall (__closure *TsbxArchiveWriterActionNeededEvent)(System::TObject* Sender, TsbxArchiveWriterActionNeededEventParams *e);
__property TsbxArchiveWriterActionNeededEvent OnActionNeeded = { read=FOnActionNeeded, write=FOnActionNeeded };

Remarks

The component fires this event to request a decision from the application when it encounters a conflict.

The WhatFor parameter can take one of the following values:

You can control the further flow from the event handler by setting the Action parameter to one of the following values:

AfterCompressFile Event (ArchiveWriter Component)

Marks the completion of compression of a file.

Syntax

typedef struct {
  String Path;
  __int64 FileSize;
  int DataSource;
} TsbxArchiveWriterAfterCompressFileEventParams;
typedef void __fastcall (__closure *TsbxArchiveWriterAfterCompressFileEvent)(System::TObject* Sender, TsbxArchiveWriterAfterCompressFileEventParams *e);
__property TsbxArchiveWriterAfterCompressFileEvent OnAfterCompressFile = { read=FOnAfterCompressFile, write=FOnAfterCompressFile };

Remarks

Subscribe to this event to get notified about the completion of compression of a file.

The Path parameter specifies the internal path to the entry inside the archive. The FileSize indicates the size of the file before compression, and the DataSource specifies the type of the source media.

BeforeCompressFile Event (ArchiveWriter Component)

Marks the start of compression of a file.

Syntax

typedef struct {
  String Path;
  __int64 FileSize;
  int DataSource;
} TsbxArchiveWriterBeforeCompressFileEventParams;
typedef void __fastcall (__closure *TsbxArchiveWriterBeforeCompressFileEvent)(System::TObject* Sender, TsbxArchiveWriterBeforeCompressFileEventParams *e);
__property TsbxArchiveWriterBeforeCompressFileEvent OnBeforeCompressFile = { read=FOnBeforeCompressFile, write=FOnBeforeCompressFile };

Remarks

Subscribe to this event to be notified about the start of compression of an archive entry. The handler of this event is a good place to prepare the desired data source.

The Path parameter indicates the path to the extracted entry in the archive. The FileSize specifies the size of the file before compression. Use this event handler to adjust the data source if the file is to be loaded from a stream or buffer. The DataSource parameter indicates the type of the data media:

Use PrepareFile event to adjust the file data source on the fly.

DecryptionPasswordNeeded Event (ArchiveWriter Component)

Fires when the component needs a password to decrypt the archive.

Syntax

typedef struct {
  String PasswordTarget;
  bool Cancel;
} TsbxArchiveWriterDecryptionPasswordNeededEventParams;
typedef void __fastcall (__closure *TsbxArchiveWriterDecryptionPasswordNeededEvent)(System::TObject* Sender, TsbxArchiveWriterDecryptionPasswordNeededEventParams *e);
__property TsbxArchiveWriterDecryptionPasswordNeededEvent OnDecryptionPasswordNeeded = { read=FOnDecryptionPasswordNeeded, write=FOnDecryptionPasswordNeeded };

Remarks

Component fires this event to request a decryption password from the application when it comes across an encrypted archive or entry.

Please assign the password to DecryptionPassword property inside the event handler, or set Cancel to true to cancel the operation. The PasswordTarget parameter references the object that is protected with the requested password.

Error Event (ArchiveWriter Component)

Reports information about errors during archive assembling.

Syntax

typedef struct {
  int ErrorCode;
  String Description;
} TsbxArchiveWriterErrorEventParams;
typedef void __fastcall (__closure *TsbxArchiveWriterErrorEvent)(System::TObject* Sender, TsbxArchiveWriterErrorEventParams *e);
__property TsbxArchiveWriterErrorEvent OnError = { read=FOnError, write=FOnError };

Remarks

The event is fired in case of exceptional conditions during archive formation.

ErrorCode contains an error code and Description contains a textual description of the error.

Notification Event (ArchiveWriter Component)

This event notifies the application about an underlying control flow event.

Syntax

typedef struct {
  String EventID;
  String EventParam;
} TsbxArchiveWriterNotificationEventParams;
typedef void __fastcall (__closure *TsbxArchiveWriterNotificationEvent)(System::TObject* Sender, TsbxArchiveWriterNotificationEventParams *e);
__property TsbxArchiveWriterNotificationEvent OnNotification = { read=FOnNotification, write=FOnNotification };

Remarks

The component fires this event to let the application know about some event, occurrence, or milestone in the component. For example, it may fire to report completion of the document processing. The list of events being reported is not fixed, and may be flexibly extended over time.

The unique identifier of the event is provided in the EventID parameter. EventParam contains any parameters accompanying the occurrence. Depending on the type of the component, the exact action it is performing, or the document being processed, one or both may be omitted.

PrepareFile Event (ArchiveWriter Component)

Fires for every file to be compressed before the compression starts.

Syntax

typedef struct {
  String Path;
  __int64 FileSize;
  int DataSource;
  String LocalPath;
  int Action;
} TsbxArchiveWriterPrepareFileEventParams;
typedef void __fastcall (__closure *TsbxArchiveWriterPrepareFileEvent)(System::TObject* Sender, TsbxArchiveWriterPrepareFileEventParams *e);
__property TsbxArchiveWriterPrepareFileEvent OnPrepareFile = { read=FOnPrepareFile, write=FOnPrepareFile };

Remarks

Component fires this event for every file included in the Files collection before commencing the compression. This is the last opportunity for your code to adjust the action to be taken for each file and tune up the data sources appropriately.

The Path parameter contains the path to the file within the archive (such as Photos/myphoto.jpg), and the FileSize contains the size of that file before compression.

The DataSource parameter indicates the media from which the file contents is to be taken. A typical default value if fdsFile, but you can adjust the value of that parameter if you need to use an alternative source. The following options are available:

The Action parameter, which is also tuneable, indicates the action for component to take on the file:

Progress Event (ArchiveWriter Component)

Reports the progress of data compression.

Syntax

typedef struct {
  __int64 Processed;
  __int64 Total;
  __int64 OverallProcessed;
  __int64 OverallTotal;
  bool Cancel;
} TsbxArchiveWriterProgressEventParams;
typedef void __fastcall (__closure *TsbxArchiveWriterProgressEvent)(System::TObject* Sender, TsbxArchiveWriterProgressEventParams *e);
__property TsbxArchiveWriterProgressEvent OnProgress = { read=FOnProgress, write=FOnProgress };

Remarks

Subscribe to this event to be notified about compression progress.

Processed and Total report the progress of compression of the current entry; OverallProcessed and OverallTotal report the progress of the whole operation. Set Cancel to true to stop the operation.

RecipientFound Event (ArchiveWriter Component)

Signifies that the archive was found to be encrypted with a digital certificate.

Syntax

typedef struct {
  String PublicKeyHash;
  bool CertFound;
} TsbxArchiveWriterRecipientFoundEventParams;
typedef void __fastcall (__closure *TsbxArchiveWriterRecipientFoundEvent)(System::TObject* Sender, TsbxArchiveWriterRecipientFoundEventParams *e);
__property TsbxArchiveWriterRecipientFoundEvent OnRecipientFound = { read=FOnRecipientFound, write=FOnRecipientFound };

Remarks

The component fires this event to notify the application that the archive was found to be encrypted with a digital certificate. The hash of the certificate's public key is provided in the PublicKeyHash parameter.

CertFound indicates whether a certificate with a matching public key hash was found in the DecryptionCertificates list. If it wasn't, you need to locate it on the system and add it to that list: component won't be able to decrypt the archive otherwise.

Please note that the certificate must have an associated private key to be capable of decryption.

Config Settings (ArchiveWriter Component)

ArchiveWriter Config Settings

 
 Copy
  writer.Config("FilenamesCharset=cp852");

Base Config Settings

 
 Copy
PKICache=certificate,crl,ocsp

 
 Copy
PKICachePath=C:\Temp\cache

 
 Copy
Config("XMLRDNDescriptorName[OID]=PrimaryName,Alias1,Alias2");

 
 Copy
Config("XMLRDNDescriptorName[2.5.4.5]=SERIALNUMBER");

 
 Copy
Config("XMLRDNDescriptorName[1.2.840.113549.1.9.1]=E,EMAIL,EMAILADDRESS");

Trappable Errors (ArchiveWriter Component)