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
IEwEXCELImportLibraryX
IEwEnvironmentX
IEwLibraryManagerX
IEwLockStringX
IEwManagerDialogX
IEwManufacturerPartCircuitX
IEwManufacturerPartManagerX
IEwManufacturerPartTerminalX
IEwMenuItemX
IEwMenuManagerX
IEwMenuX
IEwNotificationDialogX
Collapse IEwObjectDispatchXIEwObjectDispatchX
IEwPointX
IEwProjectAutomaticArrowsX
IEwProjectBookManagerX
IEwProjectCableManagerX
IEwProjectComponentManagerX
IEwProjectEntity3DManagerX
IEwProjectExcelAutomationX
IEwProjectExportDWGFilesX
IEwProjectExportPDFX
IEwProjectExportPDMX
IEwProjectExportReportX
IEwProjectFileConfigurationManagerX
IEwProjectFileConfigurationX
IEwProjectFileManagerX
IEwProjectFolderManagerX
IEwProjectFunctionManagerX
IEwProjectGenerateTSDrawingX
IEwProjectHarnessManagerX
IEwProjectInputOutputManagerX
IEwProjectLineManagerX
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 SOLIDWORKS Visualize API HelpSOLIDWORKS Visualize 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 2025.0.0
Electrical API
Public Member Functions | List of all members
IEwProjectComponentCircuitX Interface Reference

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

Inheritance diagram for IEwProjectComponentCircuitX:

Public Member Functions

IEwProjectComponentTerminalX addEwProjectComponentTerminal (EwErrorCode *errorCode)
 Create and add a terminal. More...
 
EwErrorCode deleteEwProjectComponentTerminalAt (LONG index)
 Delete a terminal. More...
 
LONG getEwProjectComponentTerminalCount ()
 Count the number of terminals. More...
 
IEwProjectComponentTerminalX getEwProjectComponentTerminalAt (LONG index, EwErrorCode *errorCode)
 Get a terminal. More...
 
BSTR getKeyCode (EwErrorCode *errorCode)
 Return the Key for the cross reference. More...
 
EwErrorCode setKeyCode (BSTR strKey)
 Sets the Key for the cross reference. More...
 
EwErrorCode setChannelAddress (BSTR strChannelAddress)
 Sets the new Channel Address. More...
 
BSTR getChannelAddress (EwErrorCode *errorCode)
 Return the Channel Address. More...
 
EwErrorCode setChannelGroup (BSTR strChannelGroup)
 Sets the new Channel Group. More...
 
BSTR getChannelGroup (EwErrorCode *errorCode)
 Return the Channel Group. More...
 
VARIANT_BOOL hasBreakPage (EwErrorCode *errorCode)
 Return if this circuit component has a break page. More...
 
EwErrorCode setBreakPage (VARIANT_BOOL bBreakPage)
 Add/Remove break page. More...
 
VARIANT_BOOL isAutomaticAddress (EwErrorCode *errorCode)
 Return if the channel address is fill in automatic. More...
 
EwErrorCode setAutomaticAddress (VARIANT_BOOL bIsAutomaticAddress)
 Sets to fill in automatic the channel address. More...
 
EwErrorCode setHidden (VARIANT_BOOL bIsHidden)
 Sets to Hide this circuit component. More...
 
long getManufacturerPartID (EwErrorCode *errorCode)
 Return the ManufacturerPart ID associated with the circuit component. More...
 
long getCircuitManufacturerPartID (EwErrorCode *errorCode)
 Return the Circuit ManufacturerPart ID associated with the circuit component. More...
 
long getSymbolID (EwErrorCode *errorCode)
 Return the Symbol ID associated with the circuit component. More...
 
long getCircuitSymbolID (EwErrorCode *errorCode)
 Return the Circuit Symbol ID associated with the circuit component. More...
 
long getComponentID (EwErrorCode *errorCode)
 Return the Component ID associated with the circuit component. More...
 
BSTR getTag (EwErrorCode *errorCode)
 Get the mark of this 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 component element inside a project.

Since
2021 SP1

Member Function Documentation

◆ addEwProjectComponentTerminal()

IEwProjectComponentTerminalX IEwProjectComponentCircuitX::addEwProjectComponentTerminal ( EwErrorCode *  errorCode)

Create and add a terminal.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred
Returns
The terminal created and added.

◆ deleteEwProjectComponentTerminalAt()

EwErrorCode IEwProjectComponentCircuitX::deleteEwProjectComponentTerminalAt ( LONG  index)

Delete a terminal.

Parameters
[in]indexThe index of terminal you want to delete
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_BAD_INPUTS if index is not valid

◆ getChannelAddress()

BSTR IEwProjectComponentCircuitX::getChannelAddress ( EwErrorCode *  errorCode)

Return the Channel Address.

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 current object has not been initialized
Returns
the Channel Address.

◆ getChannelGroup()

BSTR IEwProjectComponentCircuitX::getChannelGroup ( EwErrorCode *  errorCode)

Return the Channel Group.

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 current object has not been initialized
Returns
the Channel Group.

◆ getCircuitManufacturerPartID()

long IEwProjectComponentCircuitX::getCircuitManufacturerPartID ( EwErrorCode *  errorCode)

Return the Circuit ManufacturerPart ID associated with the circuit component.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred
Returns
the Circuit ManufacturerPart ID associated with the circuit component.

◆ getCircuitSymbolID()

long IEwProjectComponentCircuitX::getCircuitSymbolID ( EwErrorCode *  errorCode)

Return the Circuit Symbol ID associated with the circuit component.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred
Returns
the Circuit Symbol ID associated with the circuit component.

◆ getComponentID()

long IEwProjectComponentCircuitX::getComponentID ( EwErrorCode *  errorCode)

Return the Component ID associated with the circuit component.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred
Returns
the Component ID associated with the circuit component.

◆ getEwProjectComponentTerminalAt()

IEwProjectComponentTerminalX IEwProjectComponentCircuitX::getEwProjectComponentTerminalAt ( LONG  index,
EwErrorCode *  errorCode 
)

Get a terminal.

Parameters
[in]indexThe index of terminal you want to get
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_BAD_INPUTS if index is not valid
Returns
The terminal

◆ getEwProjectComponentTerminalCount()

LONG IEwProjectComponentCircuitX::getEwProjectComponentTerminalCount ( )

Count the number of terminals.

Returns
The number of terminals or -1 if this object was not initialized

◆ getKeyCode()

BSTR IEwProjectComponentCircuitX::getKeyCode ( EwErrorCode *  errorCode)

Return the Key for the cross reference.

"PIA" by default.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_INVALID_OBJECT if current object has not been initialized
  • EW_UNDEFINED_ERROR if another error occurred
Returns
the Key for the cross reference.

◆ getManufacturerPartID()

long IEwProjectComponentCircuitX::getManufacturerPartID ( EwErrorCode *  errorCode)

Return the ManufacturerPart ID associated with the circuit component.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred
Returns
the ManufacturerPart ID associated with the circuit component.

◆ getSymbolID()

long IEwProjectComponentCircuitX::getSymbolID ( EwErrorCode *  errorCode)

Return the Symbol ID associated with the circuit component.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred
Returns
the Symbol ID associated with the circuit component.

◆ getTag()

BSTR IEwProjectComponentCircuitX::getTag ( EwErrorCode *  errorCode)

Get the mark of this object.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT if current object is invalid.
  • EW_NO_ERROR if no error detected
Returns
a mark

◆ hasBreakPage()

VARIANT_BOOL IEwProjectComponentCircuitX::hasBreakPage ( EwErrorCode *  errorCode)

Return if this circuit component has a break page.

Used when printing Terminal strip or generating PLC Symbols.

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 current object has not been initialized
Returns
true if this component circuit has a break page.

◆ isAutomaticAddress()

VARIANT_BOOL IEwProjectComponentCircuitX::isAutomaticAddress ( EwErrorCode *  errorCode)

Return if the channel address is fill in automatic.

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 current object has not been initialized
Returns
true if the channel address is fill in automatic.

◆ setAutomaticAddress()

EwErrorCode IEwProjectComponentCircuitX::setAutomaticAddress ( VARIANT_BOOL  bIsAutomaticAddress)

Sets to fill in automatic the channel address.

Parameters
[in]bIsAutomaticAddresstrue to fill in automatic.
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_INVALID_OBJECT if current object has not been initialized
  • EW_UNDEFINED_ERROR if another error occurred

◆ setBreakPage()

EwErrorCode IEwProjectComponentCircuitX::setBreakPage ( VARIANT_BOOL  bBreakPage)

Add/Remove break page.

Parameters
[in]bBreakPagetrue to add break page, false to remove it.
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_INVALID_OBJECT if current object has not been initialized
  • EW_UNDEFINED_ERROR if another error occurred

◆ setChannelAddress()

EwErrorCode IEwProjectComponentCircuitX::setChannelAddress ( BSTR  strChannelAddress)

Sets the new Channel Address.

Parameters
[in]strChannelAddressthe new channel adress
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_INVALID_OBJECT if current object has not been initialized
  • EW_BAD_INPUT The strKey is not valid.
  • EW_UNDEFINED_ERROR if another error occurred

◆ setChannelGroup()

EwErrorCode IEwProjectComponentCircuitX::setChannelGroup ( BSTR  strChannelGroup)

Sets the new Channel Group.

Parameters
[in]strChannelGroupthe new channel adress
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_INVALID_OBJECT if current object has not been initialized
  • EW_BAD_INPUT The strKey is not valid.
  • EW_UNDEFINED_ERROR if another error occurred

◆ setHidden()

EwErrorCode IEwProjectComponentCircuitX::setHidden ( VARIANT_BOOL  bIsHidden)

Sets to Hide this circuit component.

Parameters
[in]bIsHiddentrue to hide this circuit component .
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_INVALID_OBJECT if current object has not been initialized
  • EW_UNDEFINED_ERROR if another error occurred

◆ setKeyCode()

EwErrorCode IEwProjectComponentCircuitX::setKeyCode ( BSTR  strKey)

Sets the Key for the cross reference.

Could be:

  • "PID" for PLC IO Input Digital
  • "PIA" for PLC IO Input Analog
  • "PIM" for PLC IO Input Misc
  • "POD" for PLC IO Output Digital
  • "POA" for PLC IO Output Analog
  • "POM" for PLC IO Output Misc
  • "P00" for PLC IO Misc
    Parameters
    [in]strKeythe new Key
    Returns
    EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_INVALID_OBJECT if current object has not been initialized
  • EW_BAD_INPUT The strKey is not valid.
  • EW_UNDEFINED_ERROR if another error occurred
Generated 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: IEwProjectComponentCircuitX 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) 2025 SP2

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