OpenProject(String,OpenMode,Boolean) Method

In This Topic

Syntax
Exceptions
Remarks
See Also

Opens a project in the requested mode if possible.

Syntax

C#
C++/CLI

public Project OpenProject( 
   string linkFileName,
   ProjectManager.OpenMode wantedOpenMode,
   bool upgradeIfNeeded
)

public:
Project^ OpenProject( 
   String^ linkFileName,
   ProjectManager.OpenMode wantedOpenMode,
   bool upgradeIfNeeded
)

Parameters

linkFileName: Full link file name "C:\\Eplan\\P8\\Projects\\EPLAN_Sample_Project.elk"
wantedOpenMode
upgradeIfNeeded: Defines if the project should be automatically upgraded it its needed

Return Value

Project : project object

Exceptions

Exception	Description
System.ArgumentException	Thrown if the source project does not exist
System.ArgumentNullException	Thrown when `linkFileName` is `null`.
ProjectOpenException	Thrown when requested project cannot be open
ProjectLockingException	Thrown when LockProjectByDefault is `true` and a project cannot be locked.
ProjectNeedsUpgradeException	Thrown when project `linkFileName` has old database structure and needs to be upgraded.
IncompatibleDatabaseException	Thrown when project `linkFileName` has incompatible database structure and we can do nothing about it.

Remarks

This method works with a project and embedded libraries: project settings, symbol libraries and the function libraries. If the project is read-only for example it is stored on a read-only drive) or number of logical pages exceeds number of licensed logical pages the project hierarchy will be opened read-only. Otherwise the project will be open read-write or exclusive, depending on available multi-user licenses. The embedded libraries always are opened read-only. Projects created by older EPLAN versions can be upgraded automatically. In case of backed-up projects please use Eplan.EplApi.HEServices.Restore class. The open mode will only be the wanted one when its possible to open the project in this mode. The Open Mode can be tested with the function Project.IsReadOnly and Project.IsExclusive after opening.

Reference

ProjectManager Class
ProjectManager Members
Overload List
Project Class

Send Feedback