Welcome
Expand Getting StartedGetting Started
Expand SOLIDWORKS API HelpSOLIDWORKS API Help
Collapse SOLIDWORKS Electrical API HelpSOLIDWORKS Electrical API Help
Expand Getting StartedGetting Started
Expand Add a Custom CommandAdd a Custom Command
Expand Add an Add-inAdd an Add-in
Expand Release NotesRelease Notes
Expand SampleSample
Collapse ClassesClasses
Expand Class ListClass List
Class Index
Collapse Class HierarchyClass Hierarchy
Collapse IDispatchIDispatch
IEwAPIX
IEwAddIn
IEwAddinInternalX
IEwApplicationSettingsX
IEwApplicationX
IEwArchiveEnvironmentX
IEwCableCoreX
IEwCableReferenceManagerX
IEwCaptionBarControlX
IEwCaptionBarX
IEwClassificationManagerX
IEwCommandContextX
IEwCommandManagerX
IEwCommandX
IEwDialogAlignPartsParametersSelectorX
IEwDialogLocationSelectorX
IEwDialogMacroSelectorX
IEwDialogManufacturerPartOrderingX
IEwDialogManufacturerPartSelectorX
IEwDialogProgressX
IEwDialogProjectManagerX
IEwDialogResumeX
IEwDialogSummaryX
IEwDialogTaskX
IEwDockingPaneManagerX
IEwDockingPaneX
IEwDocumentManagerX
IEwDocumentX
IEwEnvironmentX
IEwLibraryManagerX
IEwLockStringX
IEwManagerDialogX
IEwManufacturerPartCircuitX
IEwManufacturerPartManagerX
IEwManufacturerPartTerminalX
IEwMenuItemX
IEwMenuManagerX
IEwMenuX
IEwNotificationDialogX
Expand IEwObjectDispatchXIEwObjectDispatchX
IEwPointX
IEwProjectAutomaticArrowsX
IEwProjectBookManagerX
IEwProjectCableManagerX
IEwProjectComponentManagerX
IEwProjectEntity3DManagerX
IEwProjectExcelAutomationX
IEwProjectExportDWGFilesX
IEwProjectExportPDFX
IEwProjectExportPDMX
IEwProjectExportReportX
IEwProjectFileConfigurationManagerX
IEwProjectFileConfigurationX
IEwProjectFileManagerX
IEwProjectFolderManagerX
IEwProjectFunctionManagerX
IEwProjectGenerateTSDrawingX
IEwProjectHarnessManagerX
IEwProjectInputOutputManagerX
IEwProjectLocationManagerX
IEwProjectManagerX
IEwProjectManufacturerPartCircuitX
IEwProjectManufacturerPartManagerX
IEwProjectManufacturerPartTerminalX
IEwProjectMultilingualTextFontX
IEwProjectMultilingualTextManagerX
IEwProjectNumberDocumentsX
IEwProjectNumberMarksX
IEwProjectNumberWiresX
IEwProjectOptimizeWireOrderX
IEwProjectPrintConfigManagerX
IEwProjectReportManagerX
IEwProjectSnapshotManagerX
IEwProjectSnapshotX
IEwProjectSymbolManagerX
IEwProjectUpdateReplaceDataX
IEwProjectWireManagerX
IEwProjectWireStyleManagerX
IEwProjectX
IEwResumeRowX
IEwRibbonComboBoxControlX
IEwRibbonControlX
IEwRibbonGroupX
IEwRibbonQuickAccessControlX
IEwRibbonTabX
IEwRibbonX
IEwRightsManagerX
IEwSaveDWGImageX
IEwSelectorDialogX
IEwSymbolCircuitX
IEwSymbolFiltersX
IEwSymbolManagerX
IEwSymbolPointX
IEwTerminalTypeManagerX
IEwTitleBlockManagerX
IEwWireTerminationTypeManagerX
IEwXLSBookX
IEwXLSSheetX
Expand IInteropFactoryXIInteropFactoryX
Expand Class MembersClass Members
Expand SOLIDWORKS PDM Professional API HelpSOLIDWORKS PDM Professional API Help
Expand PDM Pro API Web ServicePDM Pro API Web Service
Expand FeatureWorks API HelpFeatureWorks API Help
Expand SOLIDWORKS Costing API HelpSOLIDWORKS Costing API Help
Expand SOLIDWORKS Document Manager API HelpSOLIDWORKS Document Manager API Help
Expand SOLIDWORKS Inspection API HelpSOLIDWORKS Inspection API Help
Expand SOLIDWORKS Routing API HelpSOLIDWORKS Routing API Help
Expand SOLIDWORKS Simulation API HelpSOLIDWORKS Simulation API Help
Expand SOLIDWORKS Sustainability API HelpSOLIDWORKS Sustainability API Help
Expand SOLIDWORKS Toolbox API HelpSOLIDWORKS Toolbox API Help
Expand SOLIDWORKS Utilities API HelpSOLIDWORKS Utilities API Help
Expand eDrawings API HelpeDrawings API Help
Expand DraftSight API HelpDraftSight API Help
Expand Lisp Programming BasicsLisp Programming Basics
Expand Lisp Functions OverviewLisp Functions Overview
Expand Lisp Functions ReferenceLisp Functions Reference
Expand Visual Lisp Compatible FunctionsVisual Lisp Compatible Functions
Hide Table of Contents
SOLIDWORKS Electrical API 2024.0.0
Electrical API
IEwProjectManagerX Interface Reference

Use this interface to manage IEwProjectX objects. More...

Inheritance diagram for IEwProjectManagerX:
Inheritance graph

Public Member Functions

LONG getCount ()
 
VARIANT getEwProjectArray (EwErrorCode *errorCode)
 Return the array of IEwProjectX. More...
 
IEwProjectX findEwProjectByID (LONG lId, EwErrorCode *errorCode)
 Look for a project from an ID. More...
 
IEwProjectX findEwProjectByName (BSTR strName, EwErrorCode *errorCode)
 Look for the first project from a name. More...
 
EwErrorCode archive (VARIANT vProjectIDArray, BSTR strFilePath, VARIANT_BOOL bWithDependencies)
 Archive projects. More...
 
VARIANT unarchive (BSTR strFilePath, VARIANT_BOOL bWithDependencies, EwErrorCode *errorCode)
 Unarchive projects. More...
 
IEwProjectX findProjectFromFilePath (BSTR strFilePath, EwErrorCode *errorCode)
 Return an IEwProjectX from a file path. More...
 
VARIANT_BOOL getGenerateAutomatedDrawings (EwErrorCode *errorCode)
 Option to update all generated files like Terminal strips or Reports which have been added to the project. More...
 
EwErrorCode setGenerateAutomatedDrawings (VARIANT_BOOL bGenerateAutomatedDrawings)
 Option to update all generated files like Terminal strips or Reports which have been added to the project. More...
 
IEwProjectX newEwProject (EwErrorCode *errorCode)
 Create an new IEwProjectX object that correspond at electrical project. More...
 

Detailed Description

Use this interface to manage IEwProjectX objects.

Since
2018 SP0

Member Function Documentation

◆ archive()

EwErrorCode IEwProjectManagerX::archive ( VARIANT  vProjectIDArray,
BSTR  strFilePath,
VARIANT_BOOL  bWithDependencies 
)

Archive projects.

Parameters
[in]vProjectIDArrayArray of integer. Array containing a list of project ID to archive.
[in]strFilePathFile path to a non existing file
[in]bWithDependenciesIf true will archive with dependencies
Returns
EwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • 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_NO_ERROR if no error detected

◆ findEwProjectByID()

IEwProjectX IEwProjectManagerX::findEwProjectByID ( LONG  lId,
EwErrorCode errorCode 
)

Look for a project from an ID.

Parameters
[in]lIdthe Id of the project to find.
[out]errorCodeEwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_NO_ERROR if no error detected Return a valid IEwProjectX object if the project is found, null otherwise.

◆ findEwProjectByName()

IEwProjectX IEwProjectManagerX::findEwProjectByName ( BSTR  strName,
EwErrorCode errorCode 
)

Look for the first project from a name.

Parameters
[in]strNamethe name of the project to find.
[out]errorCodeEwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_NO_ERROR if no error detected Return a valid IEwProjectX object if the project is found, null otherwise.

◆ findProjectFromFilePath()

IEwProjectX IEwProjectManagerX::findProjectFromFilePath ( BSTR  strFilePath,
EwErrorCode errorCode 
)

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]strFilePathFull file path
[out]errorCodeEwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • 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_NO_ERROR if no error detected
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]errorCodeEwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_BAD_INPUTS if vArray is null or is not an array
  • EW_FILE_FROM_HIGHER_VERSION If the file is archived from a higher version
  • EW_NO_ERROR if no error detected 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]errorCodeEwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_NO_ERROR if no error detected
Returns
Returns true by default, false otherwise.

◆ newEwProject()

IEwProjectX IEwProjectManagerX::newEwProject ( EwErrorCode errorCode)

Create an new IEwProjectX object that correspond at electrical project.

Since
2023 SP0
Parameters
[out]errorCodeEwErrorCode 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]bGenerateAutomatedDrawingscan be true or false. True for update all generated files.
Returns
EwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_NO_ERROR if no error detected

◆ unarchive()

VARIANT IEwProjectManagerX::unarchive ( BSTR  strFilePath,
VARIANT_BOOL  bWithDependencies,
EwErrorCode errorCode 
)

Unarchive projects.

Parameters
[in]strFilePathFile path to a an existing tewzip file
[in]bWithDependenciesIf true will unarchive and merge dependencies
[out]errorCodeEwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_BAD_INPUTS if strFilePath is the file missing.
  • EW_NO_ERROR if no error detected
Returns
The list of projects ID unarchived.


Provide feedback on this topic

SOLIDWORKS welcomes your feedback concerning the presentation, accuracy, and thoroughness of the documentation. Use the form below to send your comments and suggestions about this topic directly to our documentation team. The documentation team cannot answer technical support questions. Click here for information about technical support.

* Required

 
*Email:  
Subject:   Feedback on Help Topics
Page:   SOLIDWORKS Electrical API: IEwProjectManagerX Interface Reference
*Comment:  
*   I acknowledge I have read and I hereby accept the privacy policy under which my Personal Data will be used by Dassault Systèmes

Print Topic

Select the scope of content to print:




x

We have detected you are using a browser version older than Internet Explorer 7. For optimized display, we suggest upgrading your browser to Internet Explorer 7 or newer.

 Never show this message again
x

Web Help Content Version: API Help (English only) 2024 SP05

To disable Web help from within SOLIDWORKS and use local help instead, click Help > Use SOLIDWORKS Web Help.

To report problems encountered with the Web help interface and search, contact your local support representative. To provide feedback on individual help topics, use the “Feedback on this topic” link on the individual topic page.