API Help
Eplan.EplApi.HEServices Namespace / Backup Class / Project Method / Project(StringCollection,String,String,StringCollection,Type,Medium,Double,Amount,Boolean,Boolean,Boolean) Method
Collection of projects that are to be backed up. The names must contain the entire project path. Project file extensions (e.g. *.elk) don't have to be specified; they are filtered out.
String that is written as a comment into the corresponding backup property in the backed up projects.
Destination path where the backed up projects are stored.
Collection of file names under which backed up projects are to be saved. The entries of strColArcName must be listed in the same order as those of strColPrjSelection. Because strTargetpath already contains the destination path, the path must be left out when the file name is entered.
An Enum constant, which may have the following values:

Backup : Project is backed up

SourceOut : Project is filed off

Archive : Project is archived. Must not be set when "eBakMedia" parameter is "EMail".

Pack : Project is packed. Param strTargetPath is ignored.

An Enum constant, which may have the following values:

Disk : Project is backed up on hard disk, diskette...

EMail : Project is sent by e-mail. Window with new message will be shown.

If the project is to be compressed before being backed up, it is possible to automatically split the destination file into smaller sections to easily send them by e-mail. SplitSize indicates the maximum file size in megabytes. If rdSplitSize = 0, the file is not split up. If the eBakMedia parameter = Disk, rdSplitSize is ignored!
An Enum constant, which may have the following values:

All : The entire project directory is backed up.

Min : Only the database files required to restore the project are backed up; redundant database files are ignored.

If true, the database is compressed before the backup is made (at DISAM level, the EPLAN project is not compressed).
If true, external documents are included in the backup (files in the project subdirectory \DOC).
If true, image files are included in the backup (files in the project subdirectory \Images).

In This Topic
    Project(StringCollection,String,String,StringCollection,Type,Medium,Double,Amount,Boolean,Boolean,Boolean) Method
    In This Topic
    Backs up the entire project. Projects with a path specified in parameter strColPrjSelection become invalid.
    Syntax

    Parameters

    strColPrjSelection
    Collection of projects that are to be backed up. The names must contain the entire project path. Project file extensions (e.g. *.elk) don't have to be specified; they are filtered out.
    strComment
    String that is written as a comment into the corresponding backup property in the backed up projects.
    strTargetPath
    Destination path where the backed up projects are stored.
    strColArcName
    Collection of file names under which backed up projects are to be saved. The entries of strColArcName must be listed in the same order as those of strColPrjSelection. Because strTargetpath already contains the destination path, the path must be left out when the file name is entered.
    eBakMethod
    An Enum constant, which may have the following values:

    Backup : Project is backed up

    SourceOut : Project is filed off

    Archive : Project is archived. Must not be set when "eBakMedia" parameter is "EMail".

    Pack : Project is packed. Param strTargetPath is ignored.

    eBakMedia
    An Enum constant, which may have the following values:

    Disk : Project is backed up on hard disk, diskette...

    EMail : Project is sent by e-mail. Window with new message will be shown.

    dSplitSize
    If the project is to be compressed before being backed up, it is possible to automatically split the destination file into smaller sections to easily send them by e-mail. SplitSize indicates the maximum file size in megabytes. If rdSplitSize = 0, the file is not split up. If the eBakMedia parameter = Disk, rdSplitSize is ignored!
    eBakAmount
    An Enum constant, which may have the following values:

    All : The entire project directory is backed up.

    Min : Only the database files required to restore the project are backed up; redundant database files are ignored.

    bCompressPrj
    If true, the database is compressed before the backup is made (at DISAM level, the EPLAN project is not compressed).
    bInclExtDocs
    If true, external documents are included in the backup (files in the project subdirectory \DOC).
    bInclImages
    If true, image files are included in the backup (files in the project subdirectory \Images).
    Exceptions
    ExceptionDescription
    An error occurs during a data backup operation.
    The interface to the backup system cannot be generated.
    Remarks
    If the specified directory already contains a backup file with the same name, this file is overwritten. Archive names of the form <some name>.nnn (n = a digit 0 - 9) are forbidden, because an archive name of this form ( with a three-digit-extension)is automatically created when the backup file is split into several parts.
    See Also