ArchiveWriter Component

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

secureblackbox.ArchiveWriter

Remarks

Use ArchiveWriter to compress, update, and modify files in archives. 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

Work with ArchiveWriter builds on the following steps:

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.

You can combine different entry types when building your archive.

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

func (obj *ArchiveWriter) ArchiveType() (int32, error)

Possible Values

0   // Unknown
1   // Zip
2   // Gzip
3   // Bzip2
4   // Tar
5   // TarGzip
6   // TarBzip2
7   // SFX

Default Value

0

Remarks

This property indicates the type of the opened archive.

This property is read-only.

Data Type

int32

CompressionAlgorithm Property (ArchiveWriter Component)

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

Syntax

func (obj *ArchiveWriter) CompressionAlgorithm() (int32, error)
func (obj *ArchiveWriter) SetCompressionAlgorithm(value int32) error

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

int32

CompressionLevel Property (ArchiveWriter Component)

The compression level to apply to the archived data.

Syntax

func (obj *ArchiveWriter) CompressionLevel() (int32, error)
func (obj *ArchiveWriter) SetCompressionLevel(value int32) error

Default Value

6

Remarks

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

Data Type

int32

DecryptionCertCount Property (ArchiveWriter Component)

The number of records in the DecryptionCert arrays.

Syntax

func (obj *ArchiveWriter) DecryptionCertCount() (int32, error)
func (obj *ArchiveWriter) SetDecryptionCertCount(value int32) error

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.

Data Type

int32

DecryptionCertBytes Property (ArchiveWriter Component)

Returns the raw certificate data in DER format.

Syntax

func (obj *ArchiveWriter) DecryptionCertBytes(DecryptionCertIndex int32) ([]byte, error)

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.

Data Type

[]byte

DecryptionCertHandle Property (ArchiveWriter Component)

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

Syntax

func (obj *ArchiveWriter) DecryptionCertHandle(DecryptionCertIndex int32) (int64, error)
func (obj *ArchiveWriter) SetDecryptionCertHandle(DecryptionCertIndex int32, value int64) error

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. 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.

Data Type

int64

DecryptionPassword Property (ArchiveWriter Component)

The decryption password.

Syntax

func (obj *ArchiveWriter) DecryptionPassword() (string, error)
func (obj *ArchiveWriter) SetDecryptionPassword(value string) error

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

func (obj *ArchiveWriter) EncryptionAlgorithm() (string, error)
func (obj *ArchiveWriter) SetEncryptionAlgorithm(value string) error

Default Value

""

Remarks

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

Struct 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

func (obj *ArchiveWriter) EncryptionCertBytes() ([]byte, error)

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.

Data Type

[]byte

EncryptionCertHandle Property (ArchiveWriter Component)

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

Syntax

func (obj *ArchiveWriter) EncryptionCertHandle() (int64, error)
func (obj *ArchiveWriter) SetEncryptionCertHandle(value int64) error

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. 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.

Data Type

int64

EncryptionKeyLength Property (ArchiveWriter Component)

The length of the encryption key.

Syntax

func (obj *ArchiveWriter) EncryptionKeyLength() (int32, error)
func (obj *ArchiveWriter) SetEncryptionKeyLength(value int32) error

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

int32

EncryptionPassword Property (ArchiveWriter Component)

Specifies the archive encryption password.

Syntax

func (obj *ArchiveWriter) EncryptionPassword() (string, error)
func (obj *ArchiveWriter) SetEncryptionPassword(value string) error

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

func (obj *ArchiveWriter) EncryptionType() (int32, error)
func (obj *ArchiveWriter) SetEncryptionType(value int32) error

Possible Values

0   // Default
1   // NoEncryption
2   // Generic
3   // WinZip
4   // Strong

Default Value

0

Remarks

Specifies the encryption type for the archive.

Data Type

int32

FileData Property (ArchiveWriter Component)

The contents of the file being added to the archive.

Syntax

func (obj *ArchiveWriter) FileData() ([]byte, error)
func (obj *ArchiveWriter) SetFileData(value []byte) error

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.

Data Type

[]byte

FileCount Property (ArchiveWriter Component)

The number of records in the File arrays.

Syntax

func (obj *ArchiveWriter) FileCount() (int32, error)
func (obj *ArchiveWriter) SetFileCount(value int32) error

Default Value

0

Remarks

This property controls the size of the following arrays:

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

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

Data Type

int32

FileAction Property (ArchiveWriter Component)

This property contains the action to apply to the file.

Syntax

func (obj *ArchiveWriter) FileAction(FileIndex int32) (int32, error)
func (obj *ArchiveWriter) SetFileAction(FileIndex int32, value int32) error

Possible Values

0   // Add
1   // Keep
2   // Update
3   // Delete
4   // Extract
5   // Skip

Default Value

0

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.

Data Type

int32

FileAttributes Property (ArchiveWriter Component)

This property provides access to file attributes.

Syntax

func (obj *ArchiveWriter) FileAttributes(FileIndex int32) (string, error)
func (obj *ArchiveWriter) SetFileAttributes(FileIndex int32, value string) error

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:

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.

Data Type

string

FileCompressedSize Property (ArchiveWriter Component)

This property contains the size of the file after compression.

Syntax

func (obj *ArchiveWriter) FileCompressedSize(FileIndex int32) (int64, error)

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.

Data Type

int64

FileDataSource Property (ArchiveWriter Component)

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

Syntax

func (obj *ArchiveWriter) FileDataSource(FileIndex int32) (int32, error)
func (obj *ArchiveWriter) SetFileDataSource(FileIndex int32, value int32) error

Possible Values

0   // File
1   // Stream
2   // Buffer

Default Value

0

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.

Data Type

int32

FileDirectory Property (ArchiveWriter Component)

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

Syntax

func (obj *ArchiveWriter) FileDirectory(FileIndex int32) (bool, error)

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.

Data Type

bool

FileEncryptionAlgorithm Property (ArchiveWriter Component)

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

Syntax

func (obj *ArchiveWriter) FileEncryptionAlgorithm(FileIndex int32) (string, error)

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.

Data Type

string

FileEncryptionKeyLength Property (ArchiveWriter Component)

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

Syntax

func (obj *ArchiveWriter) FileEncryptionKeyLength(FileIndex int32) (int32, error)

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.

Data Type

int32

FileEncryptionType Property (ArchiveWriter Component)

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

Syntax

func (obj *ArchiveWriter) FileEncryptionType(FileIndex int32) (int32, error)

Possible Values

0   // Default
1   // NoEncryption
2   // Generic
3   // WinZip
4   // Strong

Default Value

0

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.

Data Type

int32

FileName Property (ArchiveWriter Component)

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

Syntax

func (obj *ArchiveWriter) FileName(FileIndex int32) (string, error)
func (obj *ArchiveWriter) SetFileName(FileIndex int32, value string) error

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.

Data Type

string

FileFolder Property (ArchiveWriter Component)

This property includes the containing folder of the entry.

Syntax

func (obj *ArchiveWriter) FileFolder(FileIndex int32) (string, error)

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.

Data Type

string

FileLocalPath Property (ArchiveWriter Component)

This property contains the local path associated with this entry.

Syntax

func (obj *ArchiveWriter) FileLocalPath(FileIndex int32) (string, error)
func (obj *ArchiveWriter) SetFileLocalPath(FileIndex int32, value string) error

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.

Data Type

string

FileMTime Property (ArchiveWriter Component)

This property contains the entry's last modification time.

Syntax

func (obj *ArchiveWriter) FileMTime(FileIndex int32) (string, error)
func (obj *ArchiveWriter) SetFileMTime(FileIndex int32, value string) error

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.

Data Type

string

FileNewFile Property (ArchiveWriter Component)

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

Syntax

func (obj *ArchiveWriter) FileNewFile(FileIndex int32) (bool, error)

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.

Data Type

bool

FilePath Property (ArchiveWriter Component)

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

Syntax

func (obj *ArchiveWriter) FilePath(FileIndex int32) (string, error)

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.

Data Type

string

FileSignatureCount Property (ArchiveWriter Component)

This property includes the number of signatures covering the entry.

Syntax

func (obj *ArchiveWriter) FileSignatureCount(FileIndex int32) (int32, error)

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.

Data Type

int32

FileSigned Property (ArchiveWriter Component)

This property indicates whether the entry is signed.

Syntax

func (obj *ArchiveWriter) FileSigned(FileIndex int32) (bool, error)

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.

Data Type

bool

FileSize Property (ArchiveWriter Component)

This property specifies the size of the file before compression.

Syntax

func (obj *ArchiveWriter) FileSize(FileIndex int32) (int64, error)

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.

Data Type

int64

FIPSMode Property (ArchiveWriter Component)

Reserved.

Syntax

func (obj *ArchiveWriter) FIPSMode() (bool, error)
func (obj *ArchiveWriter) SetFIPSMode(value bool) error

Default Value

false

Remarks

This property is reserved for future use.

Data Type

bool

HashAlgorithm Property (ArchiveWriter Component)

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

Syntax

func (obj *ArchiveWriter) HashAlgorithm() (string, error)
func (obj *ArchiveWriter) SetHashAlgorithm(value string) error

Default Value

""

Remarks

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

Data Type

string

NewArchive Property (ArchiveWriter Component)

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

Syntax

func (obj *ArchiveWriter) NewArchive() (bool, error)

Default Value

false

Remarks

This property is set to true if the archive is new, or to false if the struct 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

bool

Opened Property (ArchiveWriter Component)

Indicates whether class is currently in edit mode.

Syntax

func (obj *ArchiveWriter) Opened() (bool, error)

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

bool

Overwrite Property (ArchiveWriter Component)

Whether the class should overwrite existing files.

Syntax

func (obj *ArchiveWriter) Overwrite() (bool, error)
func (obj *ArchiveWriter) SetOverwrite(value bool) error

Default Value

false

Remarks

Enable this property to force overwriting of existing files.

Data Type

bool

SigningCertBytes Property (ArchiveWriter Component)

Returns the raw certificate data in DER format.

Syntax

func (obj *ArchiveWriter) SigningCertBytes() ([]byte, error)

Remarks

Returns the raw certificate data in DER format.

This property is read-only.

Data Type

[]byte

SigningCertHandle Property (ArchiveWriter Component)

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

Syntax

func (obj *ArchiveWriter) SigningCertHandle() (int64, error)
func (obj *ArchiveWriter) SetSigningCertHandle(value int64) error

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. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

Data Type

int64

SigningChainCount Property (ArchiveWriter Component)

The number of records in the SigningChain arrays.

Syntax

func (obj *ArchiveWriter) SigningChainCount() (int32, error)
func (obj *ArchiveWriter) SetSigningChainCount(value int32) error

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.

Data Type

int32

SigningChainBytes Property (ArchiveWriter Component)

Returns the raw certificate data in DER format.

Syntax

func (obj *ArchiveWriter) SigningChainBytes(SigningChainIndex int32) ([]byte, error)

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.

Data Type

[]byte

SigningChainHandle Property (ArchiveWriter Component)

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

Syntax

func (obj *ArchiveWriter) SigningChainHandle(SigningChainIndex int32) (int64, error)
func (obj *ArchiveWriter) SetSigningChainHandle(SigningChainIndex int32, value int64) error

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. 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.

Data Type

int64

AddEmptyDir Method (ArchiveWriter Component)

Adds an empty folder to the archive.

Syntax

func (obj *ArchiveWriter) AddEmptyDir(Path string) (int32, error)

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

func (obj *ArchiveWriter) AddFile(Path string, LocalPath string) (int32, error)

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

func (obj *ArchiveWriter) AddFiles(Folder string, LocalPath string, Recursive bool) error

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

func (obj *ArchiveWriter) AddVirtual(Path string) (int32, error)

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

func (obj *ArchiveWriter) Close() error

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

func (obj *ArchiveWriter) Config(ConfigurationString string) (string, error)

Remarks

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

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the struct, 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

func (obj *ArchiveWriter) CreateNew(ArchiveType int32) error

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

func (obj *ArchiveWriter) DoAction(ActionID string, ActionParams string) (string, error)

Remarks

DoAction is a generic method available in every struct. 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

func (obj *ArchiveWriter) Open(ArchiveType int32, ArchiveName string) error

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

func (obj *ArchiveWriter) OpenBytes(ArchiveType int32, ArchiveBytes []byte) error

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

func (obj *ArchiveWriter) Remove(Path string) error

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 class settings.

Syntax

func (obj *ArchiveWriter) Reset() error

Remarks

Reset is a generic method available in every struct.

Save Method (ArchiveWriter Component)

Compresses the archive and saves it to a file.

Syntax

func (obj *ArchiveWriter) Save(ArchiveName string) error

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 allocated 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

func (obj *ArchiveWriter) SaveBytes() ([]byte, error)

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 struct 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

func (obj *ArchiveWriter) UpdateFile(Path string, LocalPath string) error

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

func (obj *ArchiveWriter) UpdateFiles(Folder string, LocalPath string, AddMissingFiles bool, RemoveMissingFiles bool, Recursive bool) error

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

func (obj *ArchiveWriter) UpdateVirtual(Path string) error

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

// ArchiveWriterActionNeededEventArgs carries the ArchiveWriter ActionNeeded event's parameters.
type ArchiveWriterActionNeededEventArgs struct {...}

func (args *ArchiveWriterActionNeededEventArgs) WhatFor() int32
func (args *ArchiveWriterActionNeededEventArgs) EntryPath() string
func (args *ArchiveWriterActionNeededEventArgs) DestPath() string
func (args *ArchiveWriterActionNeededEventArgs) Description() string
func (args *ArchiveWriterActionNeededEventArgs) Action() int32
func (args *ArchiveWriterActionNeededEventArgs) SetAction(value int32)

// ArchiveWriterActionNeededEvent defines the signature of the ArchiveWriter ActionNeeded event's handler function.
type ArchiveWriterActionNeededEvent func(sender *ArchiveWriter, args *ArchiveWriterActionNeededEventArgs)

func (obj *ArchiveWriter) GetOnActionNeededHandler() ArchiveWriterActionNeededEvent
func (obj *ArchiveWriter) SetOnActionNeededHandler(handlerFunc ArchiveWriterActionNeededEvent)

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

// ArchiveWriterAfterCompressFileEventArgs carries the ArchiveWriter AfterCompressFile event's parameters.
type ArchiveWriterAfterCompressFileEventArgs struct {...}

func (args *ArchiveWriterAfterCompressFileEventArgs) Path() string
func (args *ArchiveWriterAfterCompressFileEventArgs) FileSize() int64
func (args *ArchiveWriterAfterCompressFileEventArgs) DataSource() int32
// ArchiveWriterAfterCompressFileEvent defines the signature of the ArchiveWriter AfterCompressFile event's handler function.
type ArchiveWriterAfterCompressFileEvent func(sender *ArchiveWriter, args *ArchiveWriterAfterCompressFileEventArgs)

func (obj *ArchiveWriter) GetOnAfterCompressFileHandler() ArchiveWriterAfterCompressFileEvent
func (obj *ArchiveWriter) SetOnAfterCompressFileHandler(handlerFunc ArchiveWriterAfterCompressFileEvent)

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

// ArchiveWriterBeforeCompressFileEventArgs carries the ArchiveWriter BeforeCompressFile event's parameters.
type ArchiveWriterBeforeCompressFileEventArgs struct {...}

func (args *ArchiveWriterBeforeCompressFileEventArgs) Path() string
func (args *ArchiveWriterBeforeCompressFileEventArgs) FileSize() int64
func (args *ArchiveWriterBeforeCompressFileEventArgs) DataSource() int32
// ArchiveWriterBeforeCompressFileEvent defines the signature of the ArchiveWriter BeforeCompressFile event's handler function.
type ArchiveWriterBeforeCompressFileEvent func(sender *ArchiveWriter, args *ArchiveWriterBeforeCompressFileEventArgs)

func (obj *ArchiveWriter) GetOnBeforeCompressFileHandler() ArchiveWriterBeforeCompressFileEvent
func (obj *ArchiveWriter) SetOnBeforeCompressFileHandler(handlerFunc ArchiveWriterBeforeCompressFileEvent)

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:

If passing the data from a stream or buffer, use AfterCompressFile to dispose of any objects allocated in this event handler (such as the source stream).

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

DecryptionPasswordNeeded Event (ArchiveWriter Component)

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

Syntax

// ArchiveWriterDecryptionPasswordNeededEventArgs carries the ArchiveWriter DecryptionPasswordNeeded event's parameters.
type ArchiveWriterDecryptionPasswordNeededEventArgs struct {...}

func (args *ArchiveWriterDecryptionPasswordNeededEventArgs) PasswordTarget() string
func (args *ArchiveWriterDecryptionPasswordNeededEventArgs) Cancel() bool
func (args *ArchiveWriterDecryptionPasswordNeededEventArgs) SetCancel(value bool)

// ArchiveWriterDecryptionPasswordNeededEvent defines the signature of the ArchiveWriter DecryptionPasswordNeeded event's handler function.
type ArchiveWriterDecryptionPasswordNeededEvent func(sender *ArchiveWriter, args *ArchiveWriterDecryptionPasswordNeededEventArgs)

func (obj *ArchiveWriter) GetOnDecryptionPasswordNeededHandler() ArchiveWriterDecryptionPasswordNeededEvent
func (obj *ArchiveWriter) SetOnDecryptionPasswordNeededHandler(handlerFunc ArchiveWriterDecryptionPasswordNeededEvent)

Remarks

Struct 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

// ArchiveWriterErrorEventArgs carries the ArchiveWriter Error event's parameters.
type ArchiveWriterErrorEventArgs struct {...}

func (args *ArchiveWriterErrorEventArgs) ErrorCode() int32
func (args *ArchiveWriterErrorEventArgs) Description() string
// ArchiveWriterErrorEvent defines the signature of the ArchiveWriter Error event's handler function.
type ArchiveWriterErrorEvent func(sender *ArchiveWriter, args *ArchiveWriterErrorEventArgs)

func (obj *ArchiveWriter) GetOnErrorHandler() ArchiveWriterErrorEvent
func (obj *ArchiveWriter) SetOnErrorHandler(handlerFunc ArchiveWriterErrorEvent)

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

// ArchiveWriterNotificationEventArgs carries the ArchiveWriter Notification event's parameters.
type ArchiveWriterNotificationEventArgs struct {...}

func (args *ArchiveWriterNotificationEventArgs) EventID() string
func (args *ArchiveWriterNotificationEventArgs) EventParam() string
// ArchiveWriterNotificationEvent defines the signature of the ArchiveWriter Notification event's handler function.
type ArchiveWriterNotificationEvent func(sender *ArchiveWriter, args *ArchiveWriterNotificationEventArgs)

func (obj *ArchiveWriter) GetOnNotificationHandler() ArchiveWriterNotificationEvent
func (obj *ArchiveWriter) SetOnNotificationHandler(handlerFunc ArchiveWriterNotificationEvent)

Remarks

The struct fires this event to let the application know about some event, occurrence, or milestone in the struct. 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 struct, 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

// ArchiveWriterPrepareFileEventArgs carries the ArchiveWriter PrepareFile event's parameters.
type ArchiveWriterPrepareFileEventArgs struct {...}

func (args *ArchiveWriterPrepareFileEventArgs) Path() string
func (args *ArchiveWriterPrepareFileEventArgs) FileSize() int64
func (args *ArchiveWriterPrepareFileEventArgs) DataSource() int32
func (args *ArchiveWriterPrepareFileEventArgs) SetDataSource(value int32)

func (args *ArchiveWriterPrepareFileEventArgs) LocalPath() string
func (args *ArchiveWriterPrepareFileEventArgs) SetLocalPath(value string)

func (args *ArchiveWriterPrepareFileEventArgs) Action() int32
func (args *ArchiveWriterPrepareFileEventArgs) SetAction(value int32)

// ArchiveWriterPrepareFileEvent defines the signature of the ArchiveWriter PrepareFile event's handler function.
type ArchiveWriterPrepareFileEvent func(sender *ArchiveWriter, args *ArchiveWriterPrepareFileEventArgs)

func (obj *ArchiveWriter) GetOnPrepareFileHandler() ArchiveWriterPrepareFileEvent
func (obj *ArchiveWriter) SetOnPrepareFileHandler(handlerFunc ArchiveWriterPrepareFileEvent)

Remarks

Struct 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:

Please do not assign FileStream or FileData in this event handler: this should be done further down the road in the BeforeCompressFile event handler. The purpose of this event is to prepare the compression plan by summarizing what should be done and to which files.

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

Progress Event (ArchiveWriter Component)

Reports the progress of data compression.

Syntax

// ArchiveWriterProgressEventArgs carries the ArchiveWriter Progress event's parameters.
type ArchiveWriterProgressEventArgs struct {...}

func (args *ArchiveWriterProgressEventArgs) Processed() int64
func (args *ArchiveWriterProgressEventArgs) Total() int64
func (args *ArchiveWriterProgressEventArgs) OverallProcessed() int64
func (args *ArchiveWriterProgressEventArgs) OverallTotal() int64
func (args *ArchiveWriterProgressEventArgs) Cancel() bool
func (args *ArchiveWriterProgressEventArgs) SetCancel(value bool)

// ArchiveWriterProgressEvent defines the signature of the ArchiveWriter Progress event's handler function.
type ArchiveWriterProgressEvent func(sender *ArchiveWriter, args *ArchiveWriterProgressEventArgs)

func (obj *ArchiveWriter) GetOnProgressHandler() ArchiveWriterProgressEvent
func (obj *ArchiveWriter) SetOnProgressHandler(handlerFunc ArchiveWriterProgressEvent)

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

// ArchiveWriterRecipientFoundEventArgs carries the ArchiveWriter RecipientFound event's parameters.
type ArchiveWriterRecipientFoundEventArgs struct {...}

func (args *ArchiveWriterRecipientFoundEventArgs) PublicKeyHash() string
func (args *ArchiveWriterRecipientFoundEventArgs) CertFound() bool
// ArchiveWriterRecipientFoundEvent defines the signature of the ArchiveWriter RecipientFound event's handler function.
type ArchiveWriterRecipientFoundEvent func(sender *ArchiveWriter, args *ArchiveWriterRecipientFoundEventArgs)

func (obj *ArchiveWriter) GetOnRecipientFoundHandler() ArchiveWriterRecipientFoundEvent
func (obj *ArchiveWriter) SetOnRecipientFoundHandler(handlerFunc ArchiveWriterRecipientFoundEvent)

Remarks

The struct 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: struct 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)

The struct accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the struct, access to these internal properties is provided through the Config method.

ArchiveWriter Config Settings

Base Config Settings

Trappable Errors (ArchiveWriter Component)