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 C# SamplesC# Samples
Expand List of SWE commandsList of SWE commands
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
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 2023.0.0
Electrical API
Public Member Functions | List of all members
IEwManufacturerPartCircuitX Interface Reference

Use this interface to manage a circuit inside a manufacturer part. More...

Inheritance diagram for IEwManufacturerPartCircuitX:
Inheritance graph
[legend]

Public Member Functions

IEwManufacturerPartTerminalX addEwManufacturerPartTerminal (EwErrorCode *errorCode)
 Create and add a terminal inside this circuit. More...
 
EwErrorCode deleteEwManufacturerPartTerminalAt (LONG index)
 Delete a terminal from this circuit. More...
 
LONG getEwManufacturerPartTerminalCount ()
 Count the number of terminals in this circuits. More...
 
IEwManufacturerPartTerminalX getEwManufacturerPartTerminalAt (LONG index, EwErrorCode *errorCode)
 Get terminal inside this circuit. More...
 
LONG getNumber ()
 Get number of this circuit. More...
 
BSTR getGroup (EwErrorCode *errorCode)
 Get a group of this circuit. More...
 
EwErrorCode setGroup (BSTR strGroup)
 Set a group of this circuit. More...
 
BSTR getChannelGroup (EwErrorCode *errorCode)
 Get a channel group of this circuit. More...
 
EwErrorCode setChannelGroup (BSTR strChannelGroup)
 Set a channel group of this circuit. More...
 
BSTR getChannelAddress (EwErrorCode *errorCode)
 Get a channel address of this circuit. More...
 
EwErrorCode setChannelAddress (BSTR strChannelAddress)
 Set a channel address of this circuit. More...
 
BSTR getSymbolName (EwErrorCode *errorCode)
 Get a symbol name of this circuit. More...
 
EwErrorCode setSymbolName (BSTR strSymbolName)
 Set a symbol name of this circuit. More...
 
LONG getSymbolNumber (EwErrorCode *errorCode)
 Get a symbol number of this circuit. More...
 
EwErrorCode setSymbolNumber (LONG lSymbolNumber)
 Set a symbol number of this circuit. More...
 
LONG getSymbolCircuitNumber (EwErrorCode *errorCode)
 Get the circuit number associated to this object inside the associated symbol. More...
 
EwErrorCode setSymbolCircuitNumber (LONG lSyCircuitNo)
 Set the circuit number associated to this object inside the associated symbol. More...
 
BSTR getType (EwErrorCode *errorCode)
 Get a type of this circuit. More...
 
EwErrorCode setType (BSTR strType)
 Set a type of this circuit. More...
 

Detailed Description

Use this interface to manage a circuit inside a manufacturer part.

Since
2018 SP0

Member Function Documentation

◆ addEwManufacturerPartTerminal()

IEwManufacturerPartTerminalX IEwManufacturerPartCircuitX::addEwManufacturerPartTerminal ( EwErrorCode *  errorCode)

Create and add a terminal inside this circuit.

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

◆ deleteEwManufacturerPartTerminalAt()

EwErrorCode IEwManufacturerPartCircuitX::deleteEwManufacturerPartTerminalAt ( LONG  index)

Delete a terminal from this circuit.

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

◆ getChannelAddress()

BSTR IEwManufacturerPartCircuitX::getChannelAddress ( EwErrorCode *  errorCode)

Get a channel address of this circuit.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if an error occurred
Returns
will contain the channel address of this circuit

◆ getChannelGroup()

BSTR IEwManufacturerPartCircuitX::getChannelGroup ( EwErrorCode *  errorCode)

Get a channel group of this circuit.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if an error occurred
Returns
will contain the channel group of this circuit

◆ getEwManufacturerPartTerminalAt()

IEwManufacturerPartTerminalX IEwManufacturerPartCircuitX::getEwManufacturerPartTerminalAt ( LONG  index,
EwErrorCode *  errorCode 
)

Get terminal inside this circuit.

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
Returns
The circuit

◆ getEwManufacturerPartTerminalCount()

LONG IEwManufacturerPartCircuitX::getEwManufacturerPartTerminalCount ( )

Count the number of terminals in this circuits.

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

◆ getGroup()

BSTR IEwManufacturerPartCircuitX::getGroup ( EwErrorCode *  errorCode)

Get a group of this circuit.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if an error occurred
Returns
will contain the group of this circuit

◆ getNumber()

LONG IEwManufacturerPartCircuitX::getNumber ( )

Get number of this circuit.

Returns
The circuit number or -1 if another error occurred

◆ getSymbolCircuitNumber()

LONG IEwManufacturerPartCircuitX::getSymbolCircuitNumber ( EwErrorCode *  errorCode)

Get the circuit number associated to this object inside the associated symbol.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred
Returns
The circuit number

◆ getSymbolName()

BSTR IEwManufacturerPartCircuitX::getSymbolName ( EwErrorCode *  errorCode)

Get a symbol name of this circuit.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if an error occurred
Returns
will contain the symbol name of this circuit

◆ getSymbolNumber()

LONG IEwManufacturerPartCircuitX::getSymbolNumber ( EwErrorCode *  errorCode)

Get a symbol number of this circuit.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if an error occurred
Returns
will contain the symbol number of this circuit

◆ getType()

BSTR IEwManufacturerPartCircuitX::getType ( EwErrorCode *  errorCode)

Get a type of this circuit.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if an error occurred
Returns
will contain the type of this circuit

◆ setChannelAddress()

EwErrorCode IEwManufacturerPartCircuitX::setChannelAddress ( BSTR  strChannelAddress)

Set a channel address of this circuit.

Parameters
[in]strChannelAddressThe channel address you want to set
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred

◆ setChannelGroup()

EwErrorCode IEwManufacturerPartCircuitX::setChannelGroup ( BSTR  strChannelGroup)

Set a channel group of this circuit.

Parameters
[in]strChannelGroupThe channel group you want to set
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred

◆ setGroup()

EwErrorCode IEwManufacturerPartCircuitX::setGroup ( BSTR  strGroup)

Set a group of this circuit.

Parameters
[in]strGroupThe group you want to set
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred

◆ setSymbolCircuitNumber()

EwErrorCode IEwManufacturerPartCircuitX::setSymbolCircuitNumber ( LONG  lSyCircuitNo)

Set the circuit number associated to this object inside the associated symbol.

Parameters
[in]lSyCircuitNoThe circuit number you want to set
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred

◆ setSymbolName()

EwErrorCode IEwManufacturerPartCircuitX::setSymbolName ( BSTR  strSymbolName)

Set a symbol name of this circuit.

Parameters
[in]strSymbolNameThe symbol name you want to set
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred

◆ setSymbolNumber()

EwErrorCode IEwManufacturerPartCircuitX::setSymbolNumber ( LONG  lSymbolNumber)

Set a symbol number of this circuit.

Parameters
[in]lSymbolNumberThe symbol number you want to set
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred

◆ setType()

EwErrorCode IEwManufacturerPartCircuitX::setType ( BSTR  strType)

Set a type of this circuit.

Parameters
[in]strTypeThe type you want to set
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred
Generated on Thu Aug 25 2022 16:02:38 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: IEwManufacturerPartCircuitX 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) 2023 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.48