Archive Method

Adds, extracts, or deletes files from a ComponentOne archive file.

Syntax

[form!]VSPrinter.Archive arcFileName As String, FileName As String, Action As ArchiveSettings

Remarks

The Archive method allows you to combine several files into one, optionally compressing the data.

This is especially useful for applications that save documents using the SaveDoc method. You may write custom information about the document into a data file and add the data file to the archive file created with the SaveDoc method.

To extract information from an archive file, use the ArchiveInfo property.

The parameters for the Archive method are described below:

Parameter	Description
arcFileName$	Name of the archive file, including its path.
FileName$	Name of the file to be added, deleted, or extracted from the archive.
Action%	Action to perform on the archive. Valid settings are listed in the following table.

Valid settings for the Action parameter are:

Constant	Value	Description
arcAdd	0	Adds the file FileName to the archive arcFileName, compressing it. If the archive file does not exist, it is created. If the file is already present in the archive, it is refreshed.
arcStore	1	Adds the file FileName to the archive arcFileName, without compressing it. If the archive file does not exist, it is created. If the file is already present in the archive, it is refreshed.
arcDelete	2	Removes the file FileName from the archive arcFileName.
arcExtract	3	Creates a copy of the file FileName on the disk. The file is created on the directory specified in the FileName parameter, or on the archive directory if no path is specified.

Notes:

VSPrint 8 archive files are compatible with archive files created by earlier versions of the control and are also compatible with ComponentOne's VSFlexGrid archive files.

For safety reasons, this method is disabled when the control is hosted on a Web page.