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
IEwProjectX Interface Reference

Use this interface to manage a project. More...

Inheritance diagram for IEwProjectX:
Inheritance graph

Public Member Functions

BSTR getCreoFolderPath (EwErrorCode *errorCode)
 
IEwProjectComponentManagerX getEwProjectComponentManager (EwErrorCode *errorCode)
 Get an IEwProjectComponentManagerX to manage components of this project. More...
 
IEwProjectLocationManagerX getEwProjectLocationManager (EwErrorCode *errorCode)
 Get an IEwProjectLocationManagerX to manage locations of this project. More...
 
IEwProjectManufacturerPartManagerX getEwProjectManufacturerPartManager (EwErrorCode *errorCode)
 Get an IEwProjectManufacturerPartManagerX to manage Builds of Materials of this project. More...
 
IEwRoutingDataX getEwRoutingData (EwErrorCode *errorCode)
 To get the routing data manager. More...
 
IEwProjectWireManagerX getEwProjectWireManager (EwErrorCode *errorCode)
 To get the project wire manager. More...
 
IEwProjectCableManagerX getEwProjectCableManager (EwErrorCode *errorCode)
 To get the cable manager. More...
 
IEwProjectConfigurationX getEwProjectConfiguration (EwErrorCode *errorCode)
 To get the project configuration. More...
 
LONG getID ()
 
EwErrorCode setName (BSTR strValue)
 Set the name of the project. More...
 
BSTR getName (EwErrorCode *errorCode)
 Get the name of the project. More...
 
EwErrorCode setCustomerName (BSTR strValue)
 Set the name of the customer of the project. More...
 
BSTR getCustomerName (EwErrorCode *errorCode)
 Get the name of the customer of the project. More...
 
EwErrorCode setCustomerAddress1 (BSTR strValue)
 Set the customer address 1 of the project. More...
 
BSTR getCustomerAddress1 (EwErrorCode *errorCode)
 Get the customer address 1 of the project. More...
 
EwErrorCode setCustomerAddress2 (BSTR strValue)
 Set the customer address 2 of the project. More...
 
BSTR getCustomerAddress2 (EwErrorCode *errorCode)
 Get the customer address 2 of the project. More...
 
EwErrorCode setCustomerAddress3 (BSTR strValue)
 Set the customer address 3 of the project. More...
 
BSTR getCustomerAddress3 (EwErrorCode *errorCode)
 Get the customer address 3 of the project. More...
 
EwErrorCode setDrawingOfficeName (BSTR strValue)
 Set the Drawing office name of the project. More...
 
BSTR getDrawingOfficeName (EwErrorCode *errorCode)
 Get the drawing office name of the project. More...
 
EwErrorCode setDrawingOfficeAddress1 (BSTR strValue)
 Set the drawing office address 1 of the project. More...
 
BSTR getDrawingOfficeAddress1 (EwErrorCode *errorCode)
 Get the drawing office address 1 of the project. More...
 
EwErrorCode setDrawingOfficeAddress2 (BSTR strValue)
 Set the drawing office address 2 of the project. More...
 
BSTR getDrawingOfficeAddress2 (EwErrorCode *errorCode)
 Get the drawing office address 2 of the project. More...
 
EwErrorCode setDrawingOfficeAddress3 (BSTR strValue)
 Set the drawing office address 3 of the project. More...
 
BSTR getDrawingOfficeAddress3 (EwErrorCode *errorCode)
 Get the drawing office address 3 of the project. More...
 
EwErrorCode setContractNumber (BSTR strValue)
 Set the contract number of the project. More...
 
BSTR getContractNumber (EwErrorCode *errorCode)
 Get the contract number of the project. More...
 
EwErrorCode update ()
 
EwErrorCode setUserData (LONG nUserDataNumber, BSTR strValue)
 Set user data of the object Project must be opened to be able to call this method. More...
 
BSTR getUserData (LONG nUserDataNumber, EwErrorCode *errorCode)
 Get user data of the object Project must be opened to be able to call this method. More...
 
EwErrorCode setTranslatedData (LONG nUserDataNumber, BSTR strLanguage, BSTR strValue)
 Set the value of a translated text Project must be opened to be able to call this method. More...
 
BSTR getTranslatedData (LONG nUserDataNumber, BSTR strLanguage, EwErrorCode *errorCode)
 Get the value of a translated text. More...
 
IEwProjectHarnessManagerX getEwProjectHarnessManager (EwErrorCode *errorCode)
 Get an IEwProjectHarnessManagerX to manage Harness of this project. More...
 
IEwProjectFileManagerX getEwProjectFileManager (EwErrorCode *errorCode)
 Get an IEwProjectFileManagerX to manage files of this project. More...
 
IEwProjectPrintConfigManagerX getEwProjectPrintConfigManager (EwErrorCode *errorCode)
 Get an IEwProjectPrintConfigManagerX to manage print config of this project. More...
 
VARIANT getMacroVariables (EwErrorCode *errorCode)
 Get an array of strings of the automation variables of the project, usually a macro. More...
 
EwErrorCode open (EwOpenProjectMode eOpenMode)
 open the project More...
 
EwErrorCode close ()
 close the project More...
 
EwErrorCode remove ()
 
IEwProjectExportDWGFilesX newEwProjectExportDWGFiles (EwErrorCode *errorCode)
 Create an IEwProjectExportDWGFilesX object from the associated project. More...
 
IEwProjectExportPDMX newEwProjectExportPDM (EwErrorCode *errorCode)
 Create an IEwProjectExportPDMX object from the associated project. More...
 
IEwProjectBookManagerX getEwProjectBookManager (EwErrorCode *errorCode)
 Get an IEwProjectBookManagerX to manage Books of this project. More...
 
IEwProjectReportManagerX getEwProjectReportManager (EwErrorCode *errorCode)
 Get an IEwProjectReportManagerX to manage reports of this project. More...
 
IEwProjectExportReportX newEwProjectExportReport (EwErrorCode *errorCode)
 Create an IEwProjectExportReportX object from the associated project. More...
 
EwErrorCode setExternID (BSTR strValue)
 Set the externID field in the project. More...
 
BSTR getExternID (EwErrorCode *errorCode)
 Get the externID of the project. More...
 
IEwProjectFunctionManagerX getEwProjectFunctionManager (EwErrorCode *errorCode)
 Get an IEwProjectFunctionManagerX to manage Functions of this project. More...
 
IEwProjectFolderManagerX getEwProjectFolderManager (EwErrorCode *errorCode)
 Get an IEwProjectFolderManagerX to manage Folders of this project. More...
 
DATE getModificationDate (EwErrorCode *errorCode)
 Get the modification date of the project. More...
 
IEwProjectGenerateTSDrawingX newEwProjectGenerateTSDrawing (EwErrorCode *errorCode)
 Create an IEwProjectGenerateTSDrawingX object to draw terminal strip in a project. More...
 
BSTR getFolderPath (EwProjectFolderPathValue eProjectFolderPathValue, EwErrorCode *errorCode)
 Return folder path associated to the current project. More...
 
IEwProjectSnapshotManagerX getEwProjectSnapshotManager (EwErrorCode *errorCode)
 Get an IEwProjectSnapshotManagerX to manage snapshots of this project. More...
 
IEwProjectUpdateReplaceDataX getEwProjectUpdateData (EwErrorCode *errorCode)
 Get an IEwProjectUpdateReplaceDataX to manage the update or replacedata of this project. More...
 
IEwProjectNumberWiresX newEwProjectNumberWires (EwErrorCode *errorCode)
 Create an IEwProjectNumberWiresX to manage the numbering or the renumbering wires of this project. More...
 
IEwProjectNumberMarksX newEwProjectNumberMarks (EwErrorCode *errorCode)
 Create an IEwProjectNumberMarksX to manage the renumbering marks of this project. More...
 
IEwProjectAutomaticArrowsX newEwProjectAutomaticArrows (EwErrorCode *errorCode)
 Create an IEwProjectAutomaticArrowsX to manage the Origin Destination automatic insertion. More...
 
IEwProjectNumberDocumentsX newEwProjectNumberDocumments (EwErrorCode *errorCode)
 Create an IEwProjectNumberDocumentsX to manage the renumbering document marks of this project. More...
 
IEwProjectOptimizeWireOrderX newEwProjectOptimizeWireOrder (EwErrorCode *errorCode)
 Create an IEwProjectOptimizeWireOrderX to optimize the wire order of this project. More...
 
IEwProjectSymbolManagerX getEwProjectSymbolManager (EwErrorCode *errorCode)
 Get an IEwProjectSymbolManagerX to manage ProjectSymbolManager of this project. More...
 
BSTR getModifiedBy (EwErrorCode *eErrorCode)
 Get the last user name that modified the current object. More...
 
IEwProjectExcelAutomationX newEwProjectExcelAutomation (EwErrorCode *errorCode)
 Create an IEwProjectExcelAutomationX object from the associated project. More...
 
IEwProjectExportPDFX newEwProjectExportPDF (EwErrorCode *errorCode)
 Create an IEwProjectExportPDFX object from the associated project. More...
 
BSTR getCreatedBy (EwErrorCode *eErrorCode)
 Get the user name that created the current object. More...
 
IEwProjectInputOutputManagerX getEwProjectInputOutputManager (EwErrorCode *errorCode)
 Get an IEwProjectInputOutputManagerX to manage ProjectInputOutput of this project. More...
 
EwProjectType getProjectType (EwErrorCode *errorCode)
 Get an EwProjectType enum type, can be EwProjectType.kProject for a project or EwProjectType.kMacro for a macro. More...
 
IEwProjectMultilingualTextManagerX getEwProjectMultilingualTextManager (EwErrorCode *errorCode)
 Get an IEwProjectMultilingualTextManagerX to manage Project Multilingual Text of this project. More...
 
IEwProjectFileConfigurationManagerX getEwProjectFileConfigurationManager (EwErrorCode *errorCode)
 Get an IEwProjectFileConfigurationManagerX to manage Project Report Configuration. More...
 
BSTR getPreviewFilePath (EwErrorCode *errorCode)
 Get the path of the first file of the project for the preview. More...
 
EwErrorCode insert ()
 
EwErrorCode insertFromTemplate (BSTR strTemplateName)
 
IEwProjectWireStyleManagerX getEwProjectWireStyleManagerX (EwErrorCode *errorCode)
 Get an IEwProjectWireStyleManagerX to manage project wire style. More...
 

Detailed Description

Use this interface to manage a project.

Since
2018 SP0

Member Function Documentation

◆ close()

EwErrorCode IEwProjectX::close ( )

close the project

Returns
EwErrorCode enum type, can be:
  • EW_INVALID_OBJECT if object is not valid
  • EW_CANNOT_CLOSE_PROJECT If an error happen which prevents to close the project.
  • EW_NO_ERROR if no error detected

◆ getContractNumber()

BSTR IEwProjectX::getContractNumber ( EwErrorCode errorCode)

Get the contract number of the project.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR default Error
  • EW_BAD_INPUTS if the property doesn't exists anymore
  • EW_NO_ERROR if no error detected
Returns
will contain the value of property

◆ getCreatedBy()

BSTR IEwProjectX::getCreatedBy ( EwErrorCode eErrorCode)

Get the user name that created the current object.

Since
2021
Parameters
[out]eErrorCodeEwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if an error occurred
  • EW_NO_ERROR if no error detected
Returns
will contain the user name that created the current object

◆ getCreoFolderPath()

BSTR IEwProjectX::getCreoFolderPath ( EwErrorCode errorCode)
Warning
This interface is deprecated, it returns EW_NOT_IMPLEMENTED
Returns
EW_NOT_IMPLEMENTED

◆ getCustomerAddress1()

BSTR IEwProjectX::getCustomerAddress1 ( EwErrorCode errorCode)

Get the customer address 1 of the project.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR default Error
  • EW_BAD_INPUTS if the property doesn't exists anymore
  • EW_NO_ERROR if no error detected
Returns
will contain the value of property

◆ getCustomerAddress2()

BSTR IEwProjectX::getCustomerAddress2 ( EwErrorCode errorCode)

Get the customer address 2 of the project.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR default Error
  • EW_BAD_INPUTS if the property doesn't exists anymore
  • EW_NO_ERROR if no error detected
Returns
will contain the value of property

◆ getCustomerAddress3()

BSTR IEwProjectX::getCustomerAddress3 ( EwErrorCode errorCode)

Get the customer address 3 of the project.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR default Error
  • EW_BAD_INPUTS if the property doesn't exists anymore
  • EW_NO_ERROR if no error detected
Returns
will contain the value of property

◆ getCustomerName()

BSTR IEwProjectX::getCustomerName ( EwErrorCode errorCode)

Get the name of the customer of the project.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR default Error
  • EW_BAD_INPUTS if the property doesn't exists anymore
  • EW_NO_ERROR if no error detected
Returns
will contain the value of property

◆ getDrawingOfficeAddress1()

BSTR IEwProjectX::getDrawingOfficeAddress1 ( EwErrorCode errorCode)

Get the drawing office address 1 of the project.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR default Error
  • EW_BAD_INPUTS if the property doesn't exists anymore
  • EW_NO_ERROR if no error detected
Returns
will contain the value of property

◆ getDrawingOfficeAddress2()

BSTR IEwProjectX::getDrawingOfficeAddress2 ( EwErrorCode errorCode)

Get the drawing office address 2 of the project.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR default Error
  • EW_BAD_INPUTS if the property doesn't exists anymore
  • EW_NO_ERROR if no error detected
Returns
will contain the value of property

◆ getDrawingOfficeAddress3()

BSTR IEwProjectX::getDrawingOfficeAddress3 ( EwErrorCode errorCode)

Get the drawing office address 3 of the project.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR default Error
  • EW_BAD_INPUTS if the property doesn't exists anymore
  • EW_NO_ERROR if no error detected
Returns
will contain the value of property

◆ getDrawingOfficeName()

BSTR IEwProjectX::getDrawingOfficeName ( EwErrorCode errorCode)

Get the drawing office name of the project.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR default Error
  • EW_BAD_INPUTS if the property doesn't exists anymore
  • EW_NO_ERROR if no error detected
Returns
will contain the value of property

◆ getEwProjectBookManager()

IEwProjectBookManagerX IEwProjectX::getEwProjectBookManager ( EwErrorCode errorCode)

Get an IEwProjectBookManagerX to manage Books of this project.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_PROJECT_NOTOPENED Project not opened
  • EW_NO_ERROR if no error detected
Returns
A valid IEwProjectBookManagerX object

◆ getEwProjectCableManager()

IEwProjectCableManagerX IEwProjectX::getEwProjectCableManager ( EwErrorCode errorCode)

To get the cable manager.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_NO_ACTIVEPROJECT if no active project
  • EW_NO_ERROR if no error detected
Returns
the IEwProjectCableManagerX

◆ getEwProjectComponentManager()

IEwProjectComponentManagerX IEwProjectX::getEwProjectComponentManager ( EwErrorCode errorCode)

Get an IEwProjectComponentManagerX to manage components of this project.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_PROJECT_NOTOPENED Project not opened
  • EW_NO_ERROR if no error detected
Returns
Component manager

◆ getEwProjectConfiguration()

IEwProjectConfigurationX IEwProjectX::getEwProjectConfiguration ( EwErrorCode errorCode)

To get the project configuration.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_NO_ACTIVEPROJECT if no active project
  • EW_NO_ERROR if no error detected
Returns
the IEwProjectConfigurationX

◆ getEwProjectFileConfigurationManager()

IEwProjectFileConfigurationManagerX IEwProjectX::getEwProjectFileConfigurationManager ( EwErrorCode errorCode)

Get an IEwProjectFileConfigurationManagerX to manage Project Report Configuration.

Since
2022 SP3
Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_PROJECT_NOTOPENED Project not opened
  • EW_NO_ERROR if no error detected
Returns
A valid IEwProjectFileConfigurationManagerX object

◆ getEwProjectFileManager()

IEwProjectFileManagerX IEwProjectX::getEwProjectFileManager ( EwErrorCode errorCode)

Get an IEwProjectFileManagerX to manage files of this project.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_PROJECT_NOTOPENED Project not opened
  • EW_NO_ERROR if no error detected
Returns
A valid IEwProjectFileManagerX object

◆ getEwProjectFolderManager()

IEwProjectFolderManagerX IEwProjectX::getEwProjectFolderManager ( EwErrorCode errorCode)

Get an IEwProjectFolderManagerX to manage Folders of this project.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT if object is not valid
  • EW_PROJECT_NOTOPENED Project not opened
  • EW_NO_ERROR if no error detected
Returns
A valid IEwProjectFolderManagerX object

◆ getEwProjectFunctionManager()

IEwProjectFunctionManagerX IEwProjectX::getEwProjectFunctionManager ( EwErrorCode errorCode)

Get an IEwProjectFunctionManagerX to manage Functions of this project.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_PROJECT_NOTOPENED Project not opened
  • EW_NO_ERROR if no error detected
Returns
A valid IEwProjectFunctionManagerX object

◆ getEwProjectHarnessManager()

IEwProjectHarnessManagerX IEwProjectX::getEwProjectHarnessManager ( EwErrorCode errorCode)

Get an IEwProjectHarnessManagerX to manage Harness of this project.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_PROJECT_NOTOPENED Project not opened
  • EW_NO_ERROR if no error detected
Returns
Harness manager

◆ getEwProjectInputOutputManager()

IEwProjectInputOutputManagerX IEwProjectX::getEwProjectInputOutputManager ( EwErrorCode errorCode)

Get an IEwProjectInputOutputManagerX to manage ProjectInputOutput of this project.

Since
2021 SP1
Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_PROJECT_NOTOPENED Project not opened
  • EW_NO_ERROR if no error detected
Returns
A valid IEwProjectInputOutputManagerX object

◆ getEwProjectLocationManager()

IEwProjectLocationManagerX IEwProjectX::getEwProjectLocationManager ( EwErrorCode errorCode)

Get an IEwProjectLocationManagerX to manage locations of this project.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_PROJECT_NOTOPENED Project not opened
  • EW_NO_ERROR if no error detected
Returns
Location manager

◆ getEwProjectManufacturerPartManager()

IEwProjectManufacturerPartManagerX IEwProjectX::getEwProjectManufacturerPartManager ( EwErrorCode errorCode)

Get an IEwProjectManufacturerPartManagerX to manage Builds of Materials of this project.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_PROJECT_NOTOPENED Project not opened
  • EW_NO_ERROR if no error detected
Returns
Build of material manager

◆ getEwProjectMultilingualTextManager()

IEwProjectMultilingualTextManagerX IEwProjectX::getEwProjectMultilingualTextManager ( EwErrorCode errorCode)

Get an IEwProjectMultilingualTextManagerX to manage Project Multilingual Text of this project.

Since
2023 SP0
Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_PROJECT_NOTOPENED Project not opened
  • EW_NO_ERROR if no error detected
Returns
A valid IEwProjectMultilingualTextManagerX object

◆ getEwProjectPrintConfigManager()

IEwProjectPrintConfigManagerX IEwProjectX::getEwProjectPrintConfigManager ( EwErrorCode errorCode)

Get an IEwProjectPrintConfigManagerX to manage print config of this project.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_PROJECT_NOTOPENED Project not opened
  • EW_NO_ERROR if no error detected
Returns
A valid IEwProjectPrintConfigManagerX object

◆ getEwProjectReportManager()

IEwProjectReportManagerX IEwProjectX::getEwProjectReportManager ( EwErrorCode errorCode)

Get an IEwProjectReportManagerX to manage reports of this project.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_PROJECT_NOTOPENED Project not opened
  • EW_NO_ERROR if no error detected
Returns
A valid IEwProjectReportManagerX object

◆ getEwProjectSnapshotManager()

IEwProjectSnapshotManagerX IEwProjectX::getEwProjectSnapshotManager ( EwErrorCode errorCode)

Get an IEwProjectSnapshotManagerX to manage snapshots of this project.

Since
2019 SP0
Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_PROJECT_NOTOPENED Project not opened
  • EW_NO_ERROR if no error detected
Returns
A valid IEwProjectSnapshotManagerX object

◆ getEwProjectSymbolManager()

IEwProjectSymbolManagerX IEwProjectX::getEwProjectSymbolManager ( EwErrorCode errorCode)

Get an IEwProjectSymbolManagerX to manage ProjectSymbolManager of this project.

Since
2020 SP0
Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_PROJECT_NOTOPENED Project not opened
  • EW_NO_ERROR if no error detected
Returns
A valid IEwProjectSymbolManagerX object

◆ getEwProjectUpdateData()

IEwProjectUpdateReplaceDataX IEwProjectX::getEwProjectUpdateData ( EwErrorCode errorCode)

Get an IEwProjectUpdateReplaceDataX to manage the update or replacedata of this project.

Since
2019 SP0
Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_PROJECT_NOTOPENED Project not opened
  • EW_NO_ERROR if no error detected
Returns
A valid IEwProjectUpdateReplaceDataX object

◆ getEwProjectWireManager()

IEwProjectWireManagerX IEwProjectX::getEwProjectWireManager ( EwErrorCode errorCode)

To get the project wire manager.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_NO_ACTIVEPROJECT if no active project
  • EW_NO_ERROR if no error detected
Returns
the IEwProjectWireManagerX

◆ getEwProjectWireStyleManagerX()

IEwProjectWireStyleManagerX IEwProjectX::getEwProjectWireStyleManagerX ( EwErrorCode errorCode)

Get an IEwProjectWireStyleManagerX to manage project wire style.

Since
2024 SP0
Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_PROJECT_NOTOPENED Project not opened
  • EW_NO_ERROR if no error detected
Returns
A valid IEwProjectFileConfigurationManagerX object

◆ getEwRoutingData()

IEwRoutingDataX IEwProjectX::getEwRoutingData ( EwErrorCode errorCode)

To get the routing data manager.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_NO_ACTIVEPROJECT if no active project
  • EW_NO_ERROR if no error detected
Returns
the IEwRoutingDataX

◆ getExternID()

BSTR IEwProjectX::getExternID ( EwErrorCode errorCode)

Get the externID of the project.

It's an Id to link with a PDM

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_NO_ERROR if no error detected
Returns
strValue will contain the value of value of externID

◆ getFolderPath()

BSTR IEwProjectX::getFolderPath ( EwProjectFolderPathValue  eProjectFolderPathValue,
EwErrorCode errorCode 
)

Return folder path associated to the current project.

Since
2018 SP2
Parameters
[in]eProjectFolderPathValueEnumeration type to get the associated folder path
[out]errorCodeEwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT if object is not valid
  • EW_OUT_OF_SCOPE the value of EwProjectFolderPathValue is out of the scope of the values managed by this method
  • EW_NO_ERROR if no error detected
Returns
Corresponding folder path with last backslash

◆ getID()

LONG IEwProjectX::getID ( )

◆ getMacroVariables()

VARIANT IEwProjectX::getMacroVariables ( EwErrorCode errorCode)

Get an array of strings of the automation variables of the project, usually a macro.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT if object is not valid
  • EW_BAD_INPUTS the array is not valid
  • EW_PROJECT_NOTOPENED if project is not opened
  • EW_NO_ERROR if no error detected
Returns
An array of string containing all automation variables of the project

◆ getModificationDate()

DATE IEwProjectX::getModificationDate ( EwErrorCode errorCode)

Get the modification date of the project.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_NO_ERROR if no error detected
Returns
a DATE object with the modification date

◆ getModifiedBy()

BSTR IEwProjectX::getModifiedBy ( EwErrorCode eErrorCode)

Get the last user name that modified the current object.

Since
2020 SP0
Parameters
[out]eErrorCodeEwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if an error occurred
  • EW_NO_ERROR if no error detected
Returns
will contain the user name that modified the current object

◆ getName()

BSTR IEwProjectX::getName ( EwErrorCode errorCode)

Get the name of the project.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR default Error
  • EW_BAD_INPUTS if the property doesn't exists anymore
  • EW_NO_ERROR if no error detected
Returns
will contain the value of property

◆ getPreviewFilePath()

BSTR IEwProjectX::getPreviewFilePath ( EwErrorCode errorCode)

Get the path of the first file of the project for the preview.

Since
2022 SP4
Parameters
[out]errorCodeErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if an error occurred
  • EW_INVALID_OBJECT if object is not valid
  • EW_CANNOT_CREATE_FILE impossible to create preview file
  • EW_NO_ERROR if no error detected
Returns
Path of the first file of the project for the preview

◆ getProjectType()

EwProjectType IEwProjectX::getProjectType ( EwErrorCode errorCode)

Get an EwProjectType enum type, can be EwProjectType.kProject for a project or EwProjectType.kMacro for a macro.

Since
2022 SP1
Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT if object is not valid
  • EW_PROJECT_NOTOPENED Project not opened
  • EW_NO_ERROR if no error detected
Returns
EwProjectType enum type, can be EwProjectType.kProject for a project or EwProjectType.kMacro for a macro.

◆ getTranslatedData()

BSTR IEwProjectX::getTranslatedData ( LONG  nUserDataNumber,
BSTR  strLanguage,
EwErrorCode errorCode 
)

Get the value of a translated text.

Parameters
[in]nUserDataNumberNumber of the text to get
[in]strLanguageLanguage code of the text to get
[out]errorCodeEwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_OUT_OF_SCOPE number out of the scope supported by the method
  • EW_BAD_INPUTS if the language code is not supported
  • EW_NO_ERROR No error detected
Returns
Value of the text to get

◆ getUserData()

BSTR IEwProjectX::getUserData ( LONG  nUserDataNumber,
EwErrorCode errorCode 
)

Get user data of the object Project must be opened to be able to call this method.

Parameters
[in]nUserDataNumbernumber of the user data
[out]errorCodeEwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_OUT_OF_SCOPE number out of the scope supported by the method
  • EW_NO_ERROR No error detected
Returns
value of the user data requested

◆ insert()

EwErrorCode IEwProjectX::insert ( )

◆ insertFromTemplate()

EwErrorCode IEwProjectX::insertFromTemplate ( BSTR  strTemplateName)

◆ newEwProjectAutomaticArrows()

IEwProjectAutomaticArrowsX IEwProjectX::newEwProjectAutomaticArrows ( EwErrorCode errorCode)

Create an IEwProjectAutomaticArrowsX to manage the Origin Destination automatic insertion.

Since
2019 SP0
Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_PROJECT_NOTOPENED Project not opened
  • EW_NO_ERROR if no error detected
Returns
A valid IEwProjectAutomaticArrowsX object

◆ newEwProjectExcelAutomation()

IEwProjectExcelAutomationX IEwProjectX::newEwProjectExcelAutomation ( EwErrorCode errorCode)

Create an IEwProjectExcelAutomationX object from the associated project.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_NO_ERROR if no error detected
Returns
An IEwProjectExcelAutomationX connected to the associated project

◆ newEwProjectExportDWGFiles()

IEwProjectExportDWGFilesX IEwProjectX::newEwProjectExportDWGFiles ( EwErrorCode errorCode)

Create an IEwProjectExportDWGFilesX object from the associated project.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_NO_ERROR if no error detected
Returns
An IEwProjectExportDWGFilesX connected to the associated project

◆ newEwProjectExportPDF()

IEwProjectExportPDFX IEwProjectX::newEwProjectExportPDF ( EwErrorCode errorCode)

Create an IEwProjectExportPDFX object from the associated project.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_NO_ERROR if no error detected
Returns
An IEwProjectExportPDFX connected to the associated project

◆ newEwProjectExportPDM()

IEwProjectExportPDMX IEwProjectX::newEwProjectExportPDM ( EwErrorCode errorCode)

Create an IEwProjectExportPDMX object from the associated project.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_NO_ERROR if no error detected
Returns
An IEwProjectExportPDMX connected to the associated project

◆ newEwProjectExportReport()

IEwProjectExportReportX IEwProjectX::newEwProjectExportReport ( EwErrorCode errorCode)

Create an IEwProjectExportReportX object from the associated project.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_NO_ERROR if no error detected
Returns
An IEwProjectExportReportX connected to the associated project

◆ newEwProjectGenerateTSDrawing()

IEwProjectGenerateTSDrawingX IEwProjectX::newEwProjectGenerateTSDrawing ( EwErrorCode errorCode)

Create an IEwProjectGenerateTSDrawingX object to draw terminal strip in a project.

Since
2019
Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_PROJECT_NOTOPENED Project not opened
  • EW_NO_ERROR if no error detected
Returns
An IEwProjectGenerateTSDrawingX connected to the associated project

◆ newEwProjectNumberDocumments()

IEwProjectNumberDocumentsX IEwProjectX::newEwProjectNumberDocumments ( EwErrorCode errorCode)

Create an IEwProjectNumberDocumentsX to manage the renumbering document marks of this project.

Since
2019 SP0
Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_PROJECT_NOTOPENED Project not opened
  • EW_NO_ERROR if no error detected
Returns
A valid IEwProjectNumberDocumentsX object

◆ newEwProjectNumberMarks()

IEwProjectNumberMarksX IEwProjectX::newEwProjectNumberMarks ( EwErrorCode errorCode)

Create an IEwProjectNumberMarksX to manage the renumbering marks of this project.

Since
2019 SP0
Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_PROJECT_NOTOPENED Project not opened
  • EW_NO_ERROR if no error detected
Returns
A valid IEwProjectNumberMarksX object

◆ newEwProjectNumberWires()

IEwProjectNumberWiresX IEwProjectX::newEwProjectNumberWires ( EwErrorCode errorCode)

Create an IEwProjectNumberWiresX to manage the numbering or the renumbering wires of this project.

Since
2019 SP0
Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_PROJECT_NOTOPENED Project not opened
  • EW_NO_ERROR if no error detected
Returns
A valid IEwProjectNumberWiresX object

◆ newEwProjectOptimizeWireOrder()

IEwProjectOptimizeWireOrderX IEwProjectX::newEwProjectOptimizeWireOrder ( EwErrorCode errorCode)

Create an IEwProjectOptimizeWireOrderX to optimize the wire order of this project.

Since
2019 SP0
Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_PROJECT_NOTOPENED Project not opened
  • EW_NO_ERROR if no error detected
Returns
A valid IEwProjectOptimizeWireOrderX object

◆ open()

EwErrorCode IEwProjectX::open ( EwOpenProjectMode  eOpenMode)

open the project

Parameters
[in]eOpenModeenum type, can be: kOpenForRead, kOpenForWrite or kOpenForWriteDenyWrite
Returns
EwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT if object is not valid
  • EW_CANNOT_OPEN_PROJECT error opening the project
  • EW_NO_ERROR if no error detected

◆ remove()

EwErrorCode IEwProjectX::remove ( )

◆ setContractNumber()

EwErrorCode IEwProjectX::setContractNumber ( BSTR  strValue)

Set the contract number of the project.

Parameters
[in]strValueThe value you want to apply to the property
Returns
EwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR default Error
  • EW_BAD_INPUTS if the property doesn't exists anymore
  • EW_NO_ERROR if no error detected

◆ setCustomerAddress1()

EwErrorCode IEwProjectX::setCustomerAddress1 ( BSTR  strValue)

Set the customer address 1 of the project.

Parameters
[in]strValueThe value you want to apply to the property
Returns
EwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR default Error
  • EW_BAD_INPUTS if the property doesn't exists anymore
  • EW_NO_ERROR if no error detected

◆ setCustomerAddress2()

EwErrorCode IEwProjectX::setCustomerAddress2 ( BSTR  strValue)

Set the customer address 2 of the project.

Parameters
[in]strValueThe value you want to apply to the property
Returns
EwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR default Error
  • EW_BAD_INPUTS if the property doesn't exists anymore
  • EW_NO_ERROR if no error detected

◆ setCustomerAddress3()

EwErrorCode IEwProjectX::setCustomerAddress3 ( BSTR  strValue)

Set the customer address 3 of the project.

Parameters
[in]strValueThe value you want to apply to the property
Returns
EwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR default Error
  • EW_BAD_INPUTS if the property doesn't exists anymore
  • EW_NO_ERROR if no error detected

◆ setCustomerName()

EwErrorCode IEwProjectX::setCustomerName ( BSTR  strValue)

Set the name of the customer of the project.

Parameters
[in]strValueThe value you want to apply to the property
Returns
EwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR default Error
  • EW_BAD_INPUTS if the property doesn't exists anymore
  • EW_NO_ERROR if no error detected

◆ setDrawingOfficeAddress1()

EwErrorCode IEwProjectX::setDrawingOfficeAddress1 ( BSTR  strValue)

Set the drawing office address 1 of the project.

Parameters
[in]strValueThe value you want to apply to the property
Returns
EwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR default Error
  • EW_BAD_INPUTS if the property doesn't exists anymore
  • EW_NO_ERROR if no error detected

◆ setDrawingOfficeAddress2()

EwErrorCode IEwProjectX::setDrawingOfficeAddress2 ( BSTR  strValue)

Set the drawing office address 2 of the project.

Parameters
[in]strValueThe value you want to apply to the property
Returns
EwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR default Error
  • EW_BAD_INPUTS if the property doesn't exists anymore
  • EW_NO_ERROR if no error detected

◆ setDrawingOfficeAddress3()

EwErrorCode IEwProjectX::setDrawingOfficeAddress3 ( BSTR  strValue)

Set the drawing office address 3 of the project.

Parameters
[in]strValueThe value you want to apply to the property
Returns
EwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR default Error
  • EW_BAD_INPUTS if the property doesn't exists anymore
  • EW_NO_ERROR if no error detected

◆ setDrawingOfficeName()

EwErrorCode IEwProjectX::setDrawingOfficeName ( BSTR  strValue)

Set the Drawing office name of the project.

Parameters
[in]strValueThe value you want to apply to the property
Returns
EwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR default Error
  • EW_BAD_INPUTS if the property doesn't exists anymore
  • EW_NO_ERROR if no error detected

◆ setExternID()

EwErrorCode IEwProjectX::setExternID ( BSTR  strValue)

Set the externID field in the project.

It's an Id to link with PDM

Parameters
[in]strValueThe value you want to apply to the property
Returns
EwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_NO_ERROR if no error detected

◆ setName()

EwErrorCode IEwProjectX::setName ( BSTR  strValue)

Set the name of the project.

Parameters
[in]strValueThe value you want to apply to the property
Returns
EwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR default Error
  • EW_INVALID_OBJECT if object is not valid
  • EW_BAD_INPUTS if the property doesn't exists anymore
  • EW_NO_ERROR if no error detected

◆ setTranslatedData()

EwErrorCode IEwProjectX::setTranslatedData ( LONG  nUserDataNumber,
BSTR  strLanguage,
BSTR  strValue 
)

Set the value of a translated text Project must be opened to be able to call this method.

Parameters
[in]nUserDataNumberNumber of the text to set
[in]strLanguageLanguage of the text
[in]strValueValue of the text
Returns
EwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_OUT_OF_SCOPE number out of the scope supported by the method
  • EW_BAD_INPUTS if the language code is not supported
  • EW_INVALID_OBJECT if Project is not inserted
  • EW_NO_ERROR No error detected

◆ setUserData()

EwErrorCode IEwProjectX::setUserData ( LONG  nUserDataNumber,
BSTR  strValue 
)

Set user data of the object Project must be opened to be able to call this method.

Parameters
[in]nUserDataNumbernumber of the user data
[in]strValuevalue to set
Returns
EwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_OUT_OF_SCOPE number out of the scope supported by the method
  • EW_INVALID_OBJECT if Project is not inserted
  • EW_NO_ERROR No error detected

◆ update()

EwErrorCode IEwProjectX::update ( )


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: IEwProjectX 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.