Use this interface to manage IEwProjectX objects.
More...
Use this interface to manage IEwProjectX objects.
- Since
- 2018 SP0
◆ archive()
| EwErrorCode IEwProjectManagerX::archive |
( |
VARIANT |
vProjectIDArray, |
|
|
BSTR |
strFilePath, |
|
|
VARIANT_BOOL |
bWithDependencies |
|
) |
| |
Archive projects.
- Parameters
-
| [in] | vProjectIDArray | Array of integer. Array containing a list of project ID to archive. |
| [in] | strFilePath | File path to a non existing file |
| [in] | bWithDependencies | If true will archive with dependencies |
- Returns
- EwErrorCode enum type, can be:
- EW_NO_ERROR if no error detected
- EW_BAD_INPUTS if strFilePath is an existing file.
- EW_NO_WRITE_PERMISSION if the directory to archive is in read only.
- Since
- 2020 SP1
- EW_UNDEFINED_ERROR if another error occurred
◆ findEwProjectByID()
Look for a project from an ID.
- Parameters
-
| [in] | lId | the Id of the project to find. |
| [out] | errorCode | EwErrorCode enum type, can be:
- EW_NO_ERROR if no error detected
- EW_UNDEFINED_ERROR if another error occurred Return a valid IEwProjectX object if the project is found, null otherwise.
|
◆ findEwProjectByName()
Look for the first project from a name.
- Parameters
-
| [in] | strName | the name of the project to find. |
| [out] | errorCode | EwErrorCode enum type, can be:
- EW_NO_ERROR if no error detected
- EW_UNDEFINED_ERROR if another error occurred Return a valid IEwProjectX object if the project is found, null otherwise.
|
◆ findProjectFromFilePath()
Return an IEwProjectX from a file path.
If the file doesn't belong to the associated project it will returns NULL object.
- Since
- 2019
- Parameters
-
| [in] | strFilePath | Full file path |
| [out] | errorCode | EwErrorCode enum type, can be:
- EW_NO_ERROR if no error detected
- EW_FILE_NOT_FOUND The file path does not exist
- EW_OBJECT_NOT_FOUND if the projectID corresponding to the file path exist but the Project object not found.
- EW_UNDEFINED_ERROR if another error occurred
|
- Returns
- a valid EwProjectX object if the file is found. NULL otherwise
◆ getCount()
| LONG IEwProjectManagerX::getCount |
( |
| ) |
|
- Returns
- the number of projects of associated environment.
◆ getEwProjectArray()
| VARIANT IEwProjectManagerX::getEwProjectArray |
( |
EwErrorCode * |
errorCode | ) |
|
Return the array of IEwProjectX.
- Parameters
-
| [out] | errorCode | EwErrorCode enum type, can be:
- EW_NO_ERROR if no error detected
- EW_BAD_INPUTS if vArray is null or is not an array
- EW_UNDEFINED_ERROR if another error occurred
- EW_FILE_FROM_HIGHER_VERSION If the file is archived from a higher version return the array of IEwProjectX of associated environment
|
◆ getGenerateAutomatedDrawings()
| VARIANT_BOOL IEwProjectManagerX::getGenerateAutomatedDrawings |
( |
EwErrorCode * |
errorCode | ) |
|
Option to update all generated files like Terminal strips or Reports which have been added to the project.
Default value is true.
- Since
- 2020 SP0
- Parameters
-
| [out] | errorCode | EwErrorCode enum type, can be:
- EW_NO_ERROR if no error detected
- EW_UNDEFINED_ERROR if another error occurred
|
- Returns
- Returns true by default, false otherwise.
◆ newEwProject()
Create an new IEwProjectX object that correspond at electrical project.
- Since
- 2023 SP0
- Parameters
-
| [out] | errorCode | EwErrorCode enum type, can be:
- EW_UNDEFINED_ERROR if another error occurred
- EW_INVALID_OBJECT if it's not possible to create project
- EW_NO_ERROR if no error detected
|
- Returns
- IEwProjectX project or null if it's failed.
◆ setGenerateAutomatedDrawings()
| EwErrorCode IEwProjectManagerX::setGenerateAutomatedDrawings |
( |
VARIANT_BOOL |
bGenerateAutomatedDrawings | ) |
|
Option to update all generated files like Terminal strips or Reports which have been added to the project.
Default value is true.
- Since
- 2020 SP0
- Parameters
-
| [in] | bGenerateAutomatedDrawings | can be true or false. True for update all generated files. |
- Returns
- EwErrorCode enum type, can be:
- EW_NO_ERROR if no error detected
- EW_UNDEFINED_ERROR if another error occurred
◆ unarchive()
| VARIANT IEwProjectManagerX::unarchive |
( |
BSTR |
strFilePath, |
|
|
VARIANT_BOOL |
bWithDependencies, |
|
|
EwErrorCode * |
errorCode |
|
) |
| |
Unarchive projects.
- Parameters
-
| [in] | strFilePath | File path to a an existing tewzip file |
| [in] | bWithDependencies | If true will unarchive and merge dependencies |
| [out] | errorCode | EwErrorCode enum type, can be:
- EW_NO_ERROR if no error detected
- EW_BAD_INPUTS if strFilePath is the file missing.
- EW_UNDEFINED_ERROR if another error occurred
|
- Returns
- The list of projects ID unarchived.