GetProject Method (ProjectManager)

Eplan.EplApi.DataModel Namespace / ProjectManager Class / GetProject Method

Collapse All

In This Topic

Syntax
Exceptions
Remarks
See Also

EPLAN API

GetProject Method (ProjectManager)

In This Topic

Syntax
Exceptions
Remarks
See Also

Gets an already open project.

Syntax

C#
C++/CLI

public Project GetProject( 
   string linkFileName
)

public:
Project^ GetProject( 
   String^ linkFileName
)

Parameters

linkFileName: Full link file name "C:\\Eplan\\P8\\Projects\\EPLAN_Sample_Project.elk"

Return Value

Project : project object or null

Exceptions

Exception	Description
System.ArgumentException	Thrown if the source project does not exist
System.ArgumentNullException	Thrown when `linkFileName` is `null`.
ProjectLockingException	Thrown when LockProjectByDefault is `true` and a project cannot be locked.

Remarks

if the project is not already open, this method returns null This method works with a project and embedded libraries: project settings, symbol libraries and the function libraries.

See Also

Reference

ProjectManager Class
ProjectManager Members
Project Class

EPLAN API , 17.02.2025, © by EPLAN GmbH & Co. KG. All rights reserved.

Use the Eplan Global Support Portal for feedback and support