You can access quite any function of ABE Project using the automation object with ProgID "ABE.Project". To view Visual Basic samples of using Project object see Tutorial Step 6 (Using ActiveX Automation) topic.
Here is the complete list of methods and properties of Project object in the C-style with a short description of each one:
Main:
Properties:
BSTR FileName;- project file name
Functions:
bool Load();- load a project
bool Save();- save changes in the project file
Options:
Properties:
bool SelfExtract;- use SFX prefix for new backups
UINT Ratio;- compression method (0-9)
bool VersionControl;- switch Version Control state
UINT NumStoredVersions;- set/get a stored backup version number, exstra bacups will be deleted when new one created
bool AddDate;- add backup date to a new backup file name
bool AddTime;- add backup time to a new backup file name
bool Modified;- check if the project was modified
DATE LastDateTime;- the date of the last project backup
BSTR BaseFolder;- the backup members path will be truncated by this folder
BSTR StorageFolder;- new backup file place
BSTR TargetFolder;- place to restore backups
BSTR Password;- encrypt/ decrypt backups with this password; empty string if no encryption needed
Functions:
bool Options(bool backup, bool restore);- display the Project Options window.
Backup:
Properties:
UINT BackupVersionCount;- number of project backup versions
BSTR ZipComment;- use this string as a comment to a new backup version
Functions:
bool CreateBackup(BSTR zip_name);- make a new backup version; set the zip_name to empty string to enable the default name
bool RestoreBackup(BSTR zip_name);- extract all files stored in the specified backup
bool RestoreBackupEx(BSTR zip_name, BSTR files_to_restore, BSTR files_to_skip);
- extract partial files stored in the specified backup,
where files_to_restore and files_to_skip are '|' devided mask lists
bool TestZip(BSTR zip_name);- check a specified backup integrity
bool Import(BSTR imp_file);- add external backup version to the current project
bool Export(BSTR exp_file, BSTR out_device, bool clear_if_removable, bool quiet_mode);
- copy an existing backup named exp_file to the out_device
bool ExportLast(BSTR out_device, BOOL clear_if_removable, BOOL quiet_mode);
- the same as the Export function except that this one exports the last created backup
BSTR GetBackupVersion(UINT no);- retrieve a backup name by its index
bool DeleteBackup(BSTR zip_name);- remove the specified backup
Properties:
UINT FileCount;- number of files which will be backuped
Functions:
BSTR GetFile(UINT no);- retrieve a file name by its index
bool IsExcluded(BSTR file);- check if the specified file is included to the next backup
bool SwitchExclude(BSTR file);- switch the included state of the specified file
Properties:
UINT BackupMemberCount(BSTR zip_name);
- number of files stored in the specified backup version
Functions:
BSTR GetBackupMember(BSTR zip_name, UINT no);
- retrieve the backuped file name by its index
BSTR ExtractBackupMember(BSTR zip_name, BSTR file_name, BSTR dir_name);
- extract the file_name file from the zip_name backup and place it to the dir_name folder
bool DeleteBackupMember(BSTR zip_name, BSTR member_name);
- remove the file_name file from the zip_name backup
Properties:
UINT MaskCount;- number of project's masks
Functions:
bool AddMask(BSTR masks, BSTR path, subfolders );
- add new mask to the project
bool ConfigureMask(UINT no);
- display Configure mask window for the mask with a specified index
bool GetMask([in] UINT no, BSTR * masks, BSTR * path, bool * subfolders );
- retrieve the mask by its index
bool ReplaceMask(UINT no, BSTR masks, BSTR path, bool subfolders );
- replace the mask specified by index with a new one
bool RemoveMask(UINT no);- delete the mask by its index
bool CutMask([UINT no);- delete the mask by its index and place it to the clipboard
bool CopyMask(UINT no, [out, retval] VARIANT_BOOL * Value );
- copy the mask by its index to the clipboard
bool PasteMask(UINT no);
- replace the mask specified by index with a new one from the clipboard