Welcome
Expand Getting StartedGetting Started
Expand SOLIDWORKS API HelpSOLIDWORKS API Help
Collapse SOLIDWORKS Electrical API HelpSOLIDWORKS Electrical API Help
Expand Getting StartedGetting Started
Expand Release NotesRelease Notes
Collapse ClassesClasses
Expand Class ListClass List
Class Index
Collapse Class HierarchyClass Hierarchy
_DIEwProjectXEvents
Collapse IDispatchIDispatch
IEwAddIn
IEwAPIX
IEwApplicationReactorX
IEwApplicationSettingsX
IEwApplicationX
IEwArchiveEnvironmentX
IEwCableCoreX
IEwCableReferenceManagerX
IEwCableReferenceX
IEwCaptionBarControlX
IEwCaptionBarX
IEwCommandContextX
IEwCommandManagerX
IEwCommandX
IEwDialogAlignPartsParametersSelectorX
IEwDialogLocationSelectorX
IEwDialogMacroSelectorX
IEwDialogManufacturerPartOrderingX
IEwDialogManufacturerPartSelectorX
IEwDialogProgressX
IEwDialogProjectManagerX
IEwDialogResumeX
IEwDialogSummaryX
IEwDialogTaskX
IEwDockingPaneManagerX
IEwDockingPaneX
IEwEnvironmentX
IEwInteropFactoryX
IEwLibraryManagerX
IEwLibraryX
IEwLockStringX
IEwManagerDialogX
IEwManufacturerPartCircuitX
IEwManufacturerPartManagerX
IEwManufacturerPartTerminalX
Collapse IEwObjectBaseXIEwObjectBaseX
IEwPointX
IEwProjectAutomaticArrowsX
IEwProjectBookManagerX
IEwProjectCableManagerX
IEwProjectComponentManagerX
IEwProjectComponentTerminalX
IEwProjectEntity3DManagerX
IEwProjectExcelAutomationX
IEwProjectExportDWGFilesX
IEwProjectExportPDFX
IEwProjectExportPDMX
IEwProjectExportReportX
IEwProjectFileManagerX
IEwProjectFolderManagerX
IEwProjectFunctionManagerX
IEwProjectGenerateTSDrawingX
IEwProjectHarnessManagerX
IEwProjectInputOutputManagerX
IEwProjectLocationManagerX
IEwProjectManagerX
IEwProjectManufacturerPartCircuitX
IEwProjectManufacturerPartManagerX
IEwProjectManufacturerPartTerminalX
IEwProjectManufacturerPartX
IEwProjectNumberDocumentsX
IEwProjectNumberMarksX
IEwProjectNumberWiresX
IEwProjectOptimizeWireOrderX
IEwProjectPrintConfigManagerX
IEwProjectReportManagerX
IEwProjectSnapshotManagerX
IEwProjectSnapshotX
IEwProjectSymbolManagerX
IEwProjectUpdateReplaceDataX
IEwProjectWireManagerX
IEwProjectX
IEwResumeRowX
IEwRibbonComboBoxControlX
IEwRibbonControlX
IEwRibbonGroupX
IEwRibbonQuickAccessControlX
IEwRibbonTabX
IEwRibbonX
IEwRightsManagerX
IEwSaveDWGImageX
IEwSymbolCircuitX
IEwSymbolFiltersX
IEwSymbolManagerX
IEwSymbolPointX
IEwSymbolX
IEwTerminalTypeManagerX
IEwTitleBlockManagerX
IEwTitleBlockX
IEwWireTerminationTypeManagerX
IEwXLSBookX
IEwXLSSheetX
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  2022.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:
[legend]

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 *pErrorCode)
 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...
 
- 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...
 
- 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

◆ 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. .

◆ 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 *  pErrorCode)

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.

◆ 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.

◆ 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

◆ 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.

◆ 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 Wed Aug 18 2021 10:34:11 for SOLIDWORKS Electrical API by   doxygen 1.8.18


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) 2022 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.46