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
Collapse Class ListClass List
Expand IEwAddInIEwAddIn
IEwAddinInternalX
Expand IEwAPIXIEwAPIX
Expand IEwApplicationSettingsXIEwApplicationSettingsX
Expand IEwApplicationXIEwApplicationX
Expand IEwArchiveEnvironmentXIEwArchiveEnvironmentX
Expand IEwCableCoreXIEwCableCoreX
Expand IEwCableReferenceManagerXIEwCableReferenceManagerX
Expand IEwCableReferenceXIEwCableReferenceX
Expand IEwCaptionBarControlXIEwCaptionBarControlX
Expand IEwCaptionBarXIEwCaptionBarX
Expand IEwClassificationManagerXIEwClassificationManagerX
Expand IEwClassificationXIEwClassificationX
Expand IEwClassXIEwClassX
IEwCommandContextX
Expand IEwCommandManagerXIEwCommandManagerX
Expand IEwCommandXIEwCommandX
Expand IEwDialogAlignPartsParametersSelectorXIEwDialogAlignPartsParametersSelectorX
Expand IEwDialogLocationSelectorXIEwDialogLocationSelectorX
Expand IEwDialogMacroSelectorXIEwDialogMacroSelectorX
Expand IEwDialogManufacturerPartOrderingXIEwDialogManufacturerPartOrderingX
Expand IEwDialogManufacturerPartSelectorXIEwDialogManufacturerPartSelectorX
Expand IEwDialogProgressXIEwDialogProgressX
Expand IEwDialogProjectManagerXIEwDialogProjectManagerX
Expand IEwDialogResumeXIEwDialogResumeX
Expand IEwDialogSummaryXIEwDialogSummaryX
Expand IEwDialogTaskXIEwDialogTaskX
Expand IEwDockingPaneManagerXIEwDockingPaneManagerX
Expand IEwDockingPaneXIEwDockingPaneX
Expand IEwDocumentManagerXIEwDocumentManagerX
Expand IEwDocumentXIEwDocumentX
Expand IEwEnvironmentObjectXIEwEnvironmentObjectX
Expand IEwEnvironmentXIEwEnvironmentX
IEwInteropFactoryX
Expand IEwLibraryManagerXIEwLibraryManagerX
Expand IEwLibraryXIEwLibraryX
Expand IEwLockStringXIEwLockStringX
Expand IEwManagerDialogXIEwManagerDialogX
Expand IEwManufacturerPartCircuitXIEwManufacturerPartCircuitX
Expand IEwManufacturerPartManagerXIEwManufacturerPartManagerX
Expand IEwManufacturerPartTerminalXIEwManufacturerPartTerminalX
Expand IEwManufacturerPartXIEwManufacturerPartX
Expand IEwMenuItemXIEwMenuItemX
Expand IEwMenuManagerXIEwMenuManagerX
Expand IEwMenuXIEwMenuX
Expand IEwNotificationDialogXIEwNotificationDialogX
Expand IEwObjectBaseXIEwObjectBaseX
IEwObjectDispatchX
Expand IEwObjectXIEwObjectX
Expand IEwPointXIEwPointX
Expand IEwProjectAutomaticArrowsXIEwProjectAutomaticArrowsX
Expand IEwProjectBookManagerXIEwProjectBookManagerX
Expand IEwProjectBookXIEwProjectBookX
Expand IEwProjectCableManagerXIEwProjectCableManagerX
Expand IEwProjectCableXIEwProjectCableX
Expand IEwProjectComponentCircuitXIEwProjectComponentCircuitX
Expand IEwProjectComponentManagerXIEwProjectComponentManagerX
Expand IEwProjectComponentTerminalXIEwProjectComponentTerminalX
Collapse IEwProjectComponentXIEwProjectComponentX
Expand IEwProjectConfigurationXIEwProjectConfigurationX
Expand IEwProjectEntity3DManagerXIEwProjectEntity3DManagerX
Expand IEwProjectEntity3DXIEwProjectEntity3DX
Expand IEwProjectExcelAutomationXIEwProjectExcelAutomationX
Expand IEwProjectExportDWGFilesXIEwProjectExportDWGFilesX
Expand IEwProjectExportPDFXIEwProjectExportPDFX
Expand IEwProjectExportPDMXIEwProjectExportPDMX
Expand IEwProjectExportReportXIEwProjectExportReportX
Expand IEwProjectFileConfigurationManagerXIEwProjectFileConfigurationManagerX
Expand IEwProjectFileConfigurationXIEwProjectFileConfigurationX
Expand IEwProjectFileManagerXIEwProjectFileManagerX
Expand IEwProjectFileXIEwProjectFileX
Expand IEwProjectFolderManagerXIEwProjectFolderManagerX
Expand IEwProjectFolderXIEwProjectFolderX
Expand IEwProjectFunctionManagerXIEwProjectFunctionManagerX
Expand IEwProjectFunctionXIEwProjectFunctionX
Expand IEwProjectGenerateTSDrawingXIEwProjectGenerateTSDrawingX
Expand IEwProjectHarnessManagerXIEwProjectHarnessManagerX
Expand IEwProjectHarnessXIEwProjectHarnessX
Expand IEwProjectInputOutputManagerXIEwProjectInputOutputManagerX
Expand IEwProjectInputOutputXIEwProjectInputOutputX
Expand IEwProjectLocationManagerXIEwProjectLocationManagerX
Expand IEwProjectLocationXIEwProjectLocationX
Expand IEwProjectManagerXIEwProjectManagerX
IEwProjectManufacturerPartCircuitX
Expand IEwProjectManufacturerPartManagerXIEwProjectManufacturerPartManagerX
IEwProjectManufacturerPartTerminalX
Expand IEwProjectManufacturerPartXIEwProjectManufacturerPartX
Expand IEwProjectMultilingualTextFontXIEwProjectMultilingualTextFontX
Expand IEwProjectMultilingualTextManagerXIEwProjectMultilingualTextManagerX
Expand IEwProjectMultilingualTextXIEwProjectMultilingualTextX
Expand IEwProjectNumberDocumentsXIEwProjectNumberDocumentsX
Expand IEwProjectNumberMarksXIEwProjectNumberMarksX
Expand IEwProjectNumberWiresXIEwProjectNumberWiresX
Expand IEwProjectOptimizeWireOrderXIEwProjectOptimizeWireOrderX
Expand IEwProjectPrintConfigManagerXIEwProjectPrintConfigManagerX
Expand IEwProjectPrintConfigXIEwProjectPrintConfigX
Expand IEwProjectReportManagerXIEwProjectReportManagerX
Expand IEwProjectReportXIEwProjectReportX
Expand IEwProjectSnapshotManagerXIEwProjectSnapshotManagerX
Expand IEwProjectSnapshotXIEwProjectSnapshotX
Expand IEwProjectSymbolManagerXIEwProjectSymbolManagerX
Expand IEwProjectSymbolXIEwProjectSymbolX
Expand IEwProjectTagObjectXIEwProjectTagObjectX
Expand IEwProjectUpdateReplaceDataXIEwProjectUpdateReplaceDataX
Expand IEwProjectWireManagerXIEwProjectWireManagerX
Expand IEwProjectWireStyleGroupXIEwProjectWireStyleGroupX
Expand IEwProjectWireStyleManagerXIEwProjectWireStyleManagerX
Expand IEwProjectWireStyleXIEwProjectWireStyleX
Expand IEwProjectWireXIEwProjectWireX
Expand IEwProjectXIEwProjectX
Expand IEwResumeRowXIEwResumeRowX
Expand IEwRibbonComboBoxControlXIEwRibbonComboBoxControlX
Expand IEwRibbonControlXIEwRibbonControlX
Expand IEwRibbonGroupXIEwRibbonGroupX
Expand IEwRibbonQuickAccessControlXIEwRibbonQuickAccessControlX
Expand IEwRibbonTabXIEwRibbonTabX
Expand IEwRibbonXIEwRibbonX
Expand IEwRightsManagerXIEwRightsManagerX
Expand IEwSaveDWGImageXIEwSaveDWGImageX
Expand IEwSelectorDialogXIEwSelectorDialogX
Expand IEwSymbolCircuitXIEwSymbolCircuitX
Expand IEwSymbolFiltersXIEwSymbolFiltersX
Expand IEwSymbolManagerXIEwSymbolManagerX
Expand IEwSymbolPointXIEwSymbolPointX
Expand IEwSymbolXIEwSymbolX
Expand IEwTerminalTypeManagerXIEwTerminalTypeManagerX
Expand IEwTerminalTypeXIEwTerminalTypeX
Expand IEwTitleBlockManagerXIEwTitleBlockManagerX
Expand IEwTitleBlockXIEwTitleBlockX
Expand IEwWireTerminationTypeManagerXIEwWireTerminationTypeManagerX
Expand IEwWireTerminationTypeXIEwWireTerminationTypeX
Expand IEwXLSBookXIEwXLSBookX
Expand IEwXLSSheetXIEwXLSSheetX
Expand IInteropFactoryXIInteropFactoryX
Class Index
Expand Class HierarchyClass Hierarchy
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
Public Member Functions | List of all members
IEwProjectComponentX Interface Reference

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

Inheritance diagram for IEwProjectComponentX:
Inheritance graph

Public Member Functions

BSTR getTagPath (EwErrorCode *errorCode)
 Get the Mark path of the component, example: -N1-R1-M1. More...
 
VARIANT_BOOL getToDraw (EwErrorCode *errorCode)
 Return true if it is drawable. More...
 
EwErrorCode setToDraw (VARIANT_BOOL bToDraw)
 Set this value to true to draw the terminal strip drawing of this component. More...
 
EwComponentType getType (EwErrorCode *errorCode)
 Return the EwComponentType enum type of the component. More...
 
EwErrorCode setType (EwComponentType eComponentType)
 Set the EwComponentType enum type of the component. More...
 
EwErrorCode setClassNodeID (LONG lNodeId)
 Set the classification node ID of this component. More...
 
LONG getClassNodeID (EwErrorCode *errorCode)
 Get the classification node ID of this component class. More...
 
LONG getLocationID (EwErrorCode *errorCode)
 Return the location ID of the component. More...
 
LONG getFunctionID (EwErrorCode *errorCode)
 Return the function ID of the component. More...
 
EwErrorCode setPropagateData (VARIANT_BOOL bPropogateData)
 Set the propagate data of Component. More...
 
VARIANT_BOOL getPropagateData (EwErrorCode *errorCode)
 Return the Propagate Data of the component. More...
 
EwErrorCode setBridgeConnection (EwAutoBridge eAutoBridge)
 Set the bridge connection enum type of Component. More...
 
EwAutoBridge getBridgeConnection (EwErrorCode *errorCode)
 Return the bridge connection enum type of the component. More...
 
EwErrorCode setPermanentComponent (VARIANT_BOOL bPermanent)
 Set permanent the component. More...
 
VARIANT_BOOL getPermanentComponent (EwErrorCode *errorCode)
 Return true if the component is permanent. More...
 
LONG getChildrenCount (EwErrorCode *errorCode)
 Return the number of children components. More...
 
EwErrorCode setParentID (LONG lParenID)
 Set the parent ID. More...
 
LONG getParentID (EwErrorCode *errorCode)
 Return the parent ID. More...
 
EwErrorCode setConfigurationFileName (BSTR strConfigName)
 Set the configuration filename of Component. More...
 
BSTR getConfigurationFileName (EwErrorCode *errorCode)
 Return the configuration filename of Component use for terminals strip drawings, connector insertion or PLC Insertion. More...
 
IEwClassificationX getClassification (EwErrorCode *errorCode)
 Get the classification of the current component. More...
 
EwErrorCode assignManufacturerPart (BSTR strManufacturer, BSTR strReference)
 Assign a Manufacturer Part to the current component. More...
 
BSTR getManufacturerDataValue (EwManufacturerDataIndex eIndexValue, EwErrorCode *errorCode)
 Get a manufacturer data value associated to the current component. More...
 
EwErrorCode setManufacturerDataValue (EwManufacturerDataIndex eIndexValue, BSTR strManufacturerDataValue)
 Set a manufacturer data value associated to the current component. More...
 
LONG getClassID (EwErrorCode *errorCode)
 Get the class ID of component. More...
 
EwErrorCode setClassID (LONG lID)
 Set the class ID of this component. More...
 
long getEwProjectLocationID (EwErrorCode *errorCode)
 Get the ID of EwProjectLocationX associated at component. More...
 
EwErrorCode setEwProjectLocationID (long lID)
 Set the EwProjectLocationX ID associated to the component. More...
 
long getEwProjectFunctionID (EwErrorCode *errorCode)
 Get the ID of EwProjectFunctionX associated at the component. More...
 
EwErrorCode setEwProjectFunctionID (long lID)
 Set the EwProjectFunctionX associated ID to the component. More...
 
- Public Member Functions inherited from IEwProjectTagObjectX
EwErrorCode setUserData (LONG nUserDataNumber, BSTR strValue)
 Set user data of the object. More...
 
BSTR getUserData (LONG nUserDataNumber, EwErrorCode *errorCode)
 Get user data of the object. More...
 
EwErrorCode setTranslatedData (LONG nUserDataNumber, BSTR strLanguage, BSTR strValue)
 Set the value of a translated text. More...
 
BSTR getTranslatedData (LONG nUserDataNumber, BSTR strLanguage, EwErrorCode *errorCode)
 Get the value of a translated text. More...
 
BSTR getTag (EwErrorCode *errorCode)
 Get the mark of this object. More...
 
EwErrorCode setTag (BSTR strValue)
 Set the mark of this object. More...
 
BSTR getTagRoot (EwErrorCode *errorCode)
 Get the mark root of this object. More...
 
EwErrorCode setTagRoot (BSTR strValue)
 Set the mark root of this object. More...
 
EwTagMode getTagMode (EwErrorCode *errorCode)
 Get the mark mode of this object. More...
 
EwErrorCode setTagMode (EwTagMode eTagMode)
 Set the mark mode of this object. More...
 
long getTagNumber (EwErrorCode *errorCode)
 Get the mark number of this object. More...
 
EwErrorCode setTagNumber (long lValue)
 Set the mark number of this object. More...
 
EwErrorCode setNextTagNumber ()
 Set the next number to have a unique mark. More...
 
VARIANT_BOOL isTagUnique (EwErrorCode *errorCode)
 Returns true or false if mark is unique. More...
 
IEwObjectX duplicate (EwErrorCode *errorCode)
 Duplicate current project object. More...
 
- Public Member Functions inherited from IEwObjectX
LONG getID ()
 
- Public Member Functions inherited from IEwObjectBaseX
EwErrorCode insert ()
 Insert the object inside the current project. More...
 
EwErrorCode remove ()
 Remove the object from the current project. More...
 
EwErrorCode update ()
 Update the object inside the current project. More...
 

Detailed Description

Use this interface to manage a component inside a project.

Since
2018 SP0

Member Function Documentation

◆ assignManufacturerPart()

EwErrorCode IEwProjectComponentX::assignManufacturerPart ( BSTR  strManufacturer,
BSTR  strReference 
)

Assign a Manufacturer Part to the current component.

Since
2023 SP0 Warning the component must be inserted before using this interface.
Parameters
[in]strManufacturerthe Manufacturer name.
[in]strReferencethe Reference name.
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_OBJECT_NOT_FOUND classification not found
  • EW_INVALID_OBJECT if component is invalid or if it's not already inserted
  • EW_BAD_INPUT if the lID not corresponding to a ManufacturerPart

◆ getBridgeConnection()

EwAutoBridge IEwProjectComponentX::getBridgeConnection ( EwErrorCode *  errorCode)

Return the bridge connection enum type of the component.

Since
2021 SP2 Only for Terminal Strip component.
Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT if object is not initialized
  • EW_BAD_INPUT if this component is not a Terminal strip
Returns
bridge connection enum type of Component.

◆ getChildrenCount()

LONG IEwProjectComponentX::getChildrenCount ( EwErrorCode *  errorCode)

Return the number of children components.

You can use this method to get the number of elements of a Terminal Strip.

Since
2021 SP2
Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT if object is not initialized
  • EW_BAD_INPUT if this component not inserted
Returns
the number of children components. .

◆ getClassID()

LONG IEwProjectComponentX::getClassID ( EwErrorCode *  errorCode)

Get the class ID of component.

Since
2023 SP0 -1 Unknown class, not initialized. -2 Unclassified elements, Minimum valid value.
Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT if object is not initialized
  • EW_NO_ERROR if no error detected
Returns
the ID of Component.

◆ getClassification()

IEwClassificationX IEwProjectComponentX::getClassification ( EwErrorCode *  errorCode)

Get the classification of the current component.

Since
2022 SP0 param[out] errorCode EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_OBJECT_NOT_FOUND classification not found
  • EW_INVALID_OBJECT if component is invalid
Returns
EwAdClassification of component

◆ getClassNodeID()

LONG IEwProjectComponentX::getClassNodeID ( EwErrorCode *  errorCode)

Get the classification node ID of this component class.

Since
2021 SP2
Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT if object is not initialized
Returns
the ID of Component class. -1 Unknown class, not initialized, -2 Unclassified elements, Minimum valid value.

◆ getConfigurationFileName()

BSTR IEwProjectComponentX::getConfigurationFileName ( EwErrorCode *  errorCode)

Return the configuration filename of Component use for terminals strip drawings, connector insertion or PLC Insertion.

Since
2021 SP2 Only for kComponentTerminalStrip, kComponentConnector or kComponentPLC enum type component from EwComponentType.
Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT if object is not initialized
  • EW_BAD_INPUT if this component is not a kComponentTerminalStrip, kComponentConnector or kComponentPLC enum type component from EwComponentType.
Returns
the configuration filename of Component.

◆ getEwProjectFunctionID()

long IEwProjectComponentX::getEwProjectFunctionID ( EwErrorCode *  errorCode)

Get the ID of EwProjectFunctionX associated at the component.

Since
2024 SP0
Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred.
  • EW_INVALID_OBJECT if object base not initialized.
  • EW_PROJECT_NOTOPENED if project not opened.
  • EW_NO_ERROR if no error detected.
Returns
ID of the associated function. -1 if no function associated.

◆ getEwProjectLocationID()

long IEwProjectComponentX::getEwProjectLocationID ( EwErrorCode *  errorCode)

Get the ID of EwProjectLocationX associated at component.

Since
2024 SP0
Parameters
[out]errorCodeEwErrorCode enum type, can be :
  • EW_UNDEFINED_ERROR if another error occurred.
  • EW_INVALID_OBJECT if object base not initialized.
  • EW_PROJECT_NOTOPENED if project not opened.
  • EW_NO_ERROR if no error detected.
  • EW_NO_ERROR if no error detected.
Returns
ID of the associated function. -1 if no location associated.

◆ getFunctionID()

LONG IEwProjectComponentX::getFunctionID ( EwErrorCode *  errorCode)

Return the function ID of the component.

Since
2021 SP2
Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT if object is not initialized
Returns
the function ID of Component.

◆ getLocationID()

LONG IEwProjectComponentX::getLocationID ( EwErrorCode *  errorCode)

Return the location ID of the component.

Since
2021 SP2
Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT if object is not initialized
Returns
the location ID of Component class.

◆ getManufacturerDataValue()

BSTR IEwProjectComponentX::getManufacturerDataValue ( EwManufacturerDataIndex  eIndexValue,
EwErrorCode *  errorCode 
)

Get a manufacturer data value associated to the current component.

Since
2023 SP0
Parameters
[in]eIndexValueis the index of the manufacturer data to get the value from.
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_CALL wrong component is called, or component doesn't belong to a specific class
  • EW_FILE_NOT_FOUND unable to find the user data description file
  • EW_INVALID_FILE invalid configuration file
  • EW_INVALID_INDEX unavailable field for this component (on the given index eIndexValue)
Returns
a manufacturer data value associated to the current component

◆ getParentID()

LONG IEwProjectComponentX::getParentID ( EwErrorCode *  errorCode)

Return the parent ID.

Since
2021 SP2
Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT if object is not initialized
Returns
the parent ID.

◆ getPermanentComponent()

VARIANT_BOOL IEwProjectComponentX::getPermanentComponent ( EwErrorCode *  errorCode)

Return true if the component is permanent.

Since
2021 SP2
Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT if object is not initialized
Returns
true if the component is permanent.

◆ getPropagateData()

VARIANT_BOOL IEwProjectComponentX::getPropagateData ( EwErrorCode *  errorCode)

Return the Propagate Data of the component.

Since
2021 SP2 Only for Terminal Strip component.
Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT if object is not initialized
  • EW_BAD_INPUT if this component is not a Terminal strip
Returns
the propagate data of Component.

◆ getTagPath()

BSTR IEwProjectComponentX::getTagPath ( EwErrorCode *  errorCode)

Get the Mark path of the component, example: -N1-R1-M1.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT if object is not initialized
Returns
Tag Path

◆ getToDraw()

VARIANT_BOOL IEwProjectComponentX::getToDraw ( EwErrorCode *  errorCode)

Return true if it is drawable.

Only for Terminal Strip component.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_BAD_INPUT if this component is not a Terminal strip
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT if object is not initialized
Returns
VARIANT_TRUE if it is drawable

◆ getType()

EwComponentType IEwProjectComponentX::getType ( EwErrorCode *  errorCode)

Return the EwComponentType enum type of the component.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT if object is not initialized
Returns
the EwComponentType enum type of the component.

◆ setBridgeConnection()

EwErrorCode IEwProjectComponentX::setBridgeConnection ( EwAutoBridge  eAutoBridge)

Set the bridge connection enum type of Component.

Since
2021 SP2 Only for Terminal Strip component.
Parameters
[in]eAutoBridgeset this new value.
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT if object is not initialized
  • EW_BAD_INPUT if this component is not a Terminal strip

◆ setClassID()

EwErrorCode IEwProjectComponentX::setClassID ( LONG  lID)

Set the class ID of this component.

Since
2023 SP0
Parameters
[in]lIDnew class you want to set
Returns
EwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT if object is not initialized
  • EW_BAD_INPUTS no class found
  • EW_NO_ERROR if no error detected

◆ setClassNodeID()

EwErrorCode IEwProjectComponentX::setClassNodeID ( LONG  lNodeId)

Set the classification node ID of this component.

Since
2021 SP2
Parameters
[in]lNodeIdnode ID of Component class. -1 Unknown class, not initialized -2 Unclassified elements, Minimum valid value
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT if object is not initialized
  • EW_BAD_INPUT if lNodeID is lower than -2

◆ setConfigurationFileName()

EwErrorCode IEwProjectComponentX::setConfigurationFileName ( BSTR  strConfigName)

Set the configuration filename of Component.

Since
2021 SP2 Only for kComponentTerminalStrip, kComponentConnector or kComponentPLC enum type component from EwComponentType.
Parameters
[in]strConfigNameset this new filename.
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT if object is not initialized
  • EW_BAD_INPUT if this component is not a kComponentTerminalStrip, kComponentConnector or kComponentPLC enum type component from EwComponentType.

◆ setEwProjectFunctionID()

EwErrorCode IEwProjectComponentX::setEwProjectFunctionID ( long  lID)

Set the EwProjectFunctionX associated ID to the component.

Since
2024 SP0
Parameters
[in]lIDid of new function to set.
Returns
errorCode EwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred.
  • EW_INVALID_OBJECT if object base not initialized.
  • EW_PROJECT_NOTOPENED if project not opened.
  • EW_OBJECT_NOT_FOUND if EwProjectFunctionX not found.
  • EW_NO_ERROR if no error detected.

◆ setEwProjectLocationID()

EwErrorCode IEwProjectComponentX::setEwProjectLocationID ( long  lID)

Set the EwProjectLocationX ID associated to the component.

Since
2024 SP0
Parameters
[in]lIDid of new location to set.
Returns
errorCode EwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred.
  • EW_INVALID_OBJECT if object base not initialized.
  • EW_PROJECT_NOTOPENED if project not opened.
  • EW_OBJECT_NOT_FOUND if EwProjectLocationX not found.
  • EW_NO_ERROR if no error detected.

◆ setManufacturerDataValue()

EwErrorCode IEwProjectComponentX::setManufacturerDataValue ( EwManufacturerDataIndex  eIndexValue,
BSTR  strManufacturerDataValue 
)

Set a manufacturer data value associated to the current component.

Since
2023 SP0
Parameters
[in]eIndexValueis the index of manufacturer data to apply the value to.
[in]strManufacturerDataValueis the manufacturer data value to apply.
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_CALL wrong component is called, or component doesn't belong to a specific class
  • EW_FILE_NOT_FOUND unable to find the user data description file
  • EW_INVALID_FILE invalid user data description file
  • EW_INVALID_INDEX unavailable field for this component (on the given index eIndexValue)

◆ setParentID()

EwErrorCode IEwProjectComponentX::setParentID ( LONG  lParenID)

Set the parent ID.

Since
2021 SP2
Parameters
[in]lParenIDthe new parent ID. -1 For no parent.
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT if object is not initialized
  • EW_BAD_INPUT if lParenID is lower than -2

◆ setPermanentComponent()

EwErrorCode IEwProjectComponentX::setPermanentComponent ( VARIANT_BOOL  bPermanent)

Set permanent the component.

Since
2021 SP2 This value could be change only after inserted it.
Parameters
[in]bPermanentTrue be set permanent the component.
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT if object is not initialized
  • EW_BAD_INPUT if this component not inserted

◆ setPropagateData()

EwErrorCode IEwProjectComponentX::setPropagateData ( VARIANT_BOOL  bPropogateData)

Set the propagate data of Component.

Since
2021 SP2 Only for Terminal Strip component.
Parameters
[in]bPropogateDataset to true to propagate data.
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT if object is not initialized
  • EW_BAD_INPUT if this component is not a Terminal strip

◆ setToDraw()

EwErrorCode IEwProjectComponentX::setToDraw ( VARIANT_BOOL  bToDraw)

Set this value to true to draw the terminal strip drawing of this component.

Can only be applied to terminal strip components. Only for Terminal Strip component.

Parameters
[in]bToDrawVARIANT_TRUE for drawing the component, VARIANT_FALSE otherwhere.
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_BAD_INPUT if this component is not a Terminal strip
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT if object is not initialized

◆ setType()

EwErrorCode IEwProjectComponentX::setType ( EwComponentType  eComponentType)

Set the EwComponentType enum type of the component.

Can only be called before the insertion of the component in the database.

Parameters
[in]eComponentTypethe type for the future component.
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT if object is not initialized
Generated on Mon Aug 28 2023 13:39:21 for SOLIDWORKS Electrical API by doxygen 1.9.4


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

0.20.21