GetProjectByGUID Method

In This Topic

Method for searching a project by a given project ID from the project management database.

Syntax

C#
C++/CLI

public bool GetProjectByGUID( 
   string strProjectGUID,
   ref string strProjectPath,
   ref string strWorkStation
)

public:
bool GetProjectByGUID( 
   String^ strProjectGUID,
   String^% strProjectPath,
   String^% strWorkStation
)

Parameters

Parameter Name	Description
strProjectGUID	Unique project ID of the wanted project.
strProjectPath	[out] Full link file name of the found project.
strWorkStation	[out] Name of the workstation on which the project is located. The parameter returns an empty string, if the project is not found or it is located on the local workstation.

Return Value

return = true: project was found. return = false: project was not found.

Exceptions

Exception	Description
Eplan.EplApi.Base.BaseException	Thrown if an error occurs while executing the method.
System.ApplicationException	Thrown if the internal interface of the project management module could no be created.

Remarks

It may happen, that a project appears more than once in the database. This may for example happen, if the project was registered as well by a local path as by a UNC path. In this case, the path, which is found first will be written to strProjectPath. Opening a project via API does not registers it in the ProjectManagement database. Please use XPrjActionProjectUpdate action or LoadDirectory method in order to add it.

Reference

ProjectManagement Class
ProjectManagement Members

Use the Eplan Global Support Portal for feedback and support