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
Collapse IEwObjectDispatchXIEwObjectDispatchX
Expand IEwObjectBaseXIEwObjectBaseX
IEwProjectComponentTerminalX
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
Public Member Functions | List of all members
IEwProjectComponentTerminalX Interface Reference

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

Inheritance diagram for IEwProjectComponentTerminalX:
Inheritance graph

Public Member Functions

LONG getCircuitID (EwErrorCode *errorCode)
 Return the circuit ID of the current terminal. More...
 
LONG getIndex (EwErrorCode *errorCode)
 Get the index of the current terminal. More...
 
BSTR getMark (EwErrorCode *errorCode)
 Get the mark of the current terminal. More...
 
EwErrorCode setMark (BSTR sTerminalMark)
 Set the mark of the current terminal. More...
 
EwPointOrientation getOrientation (EwErrorCode *errorCode)
 Get the EwPointOrientation enum type of the current terminal. More...
 
EwErrorCode setOrientation (EwPointOrientation ePointOrientation)
 Set the EwPointOrientation enum type of the current terminal. More...
 
IEwWireTerminationTypeX getWireTerminationType (EwErrorCode *errorCode)
 Get the termination type of the current terminal. More...
 
EwErrorCode setWireTerminationType (LONG lWireTerminationTypeID)
 Set a termination type to the current terminal. More...
 
LONG getMaximumWireNumber (EwErrorCode *errorCode)
 Get the maximum number of wires than can be connected to the current terminal. More...
 
EwErrorCode setMaximumWireNumber (LONG lMaxWire)
 Set the maximum number of wires than can be connected to the current terminal. More...
 
BSTR getMnemonic (EwErrorCode *errorCode)
 Get the mnemonic of the current terminal. More...
 
EwErrorCode setMnemonic (BSTR strMnemonic)
 Set the mnemonic of the current terminal. More...
 
BSTR getUtilization (EwErrorCode *errorCode)
 Get the utilization text of the current terminal. More...
 
EwErrorCode setUtilization (BSTR strUtilization)
 Set the utilization text of the current terminal. More...
 
DOUBLE getMaximumWireSection (EwErrorCode *errorCode)
 Get the maximum wire section of the current terminal in square millimeter (mm²). More...
 
EwErrorCode setMaximumWireSection (DOUBLE dMaxSection)
 Set the maximum wire section of the current terminal in square millimeter (mm²). More...
 
DOUBLE getMinimumWireSection (EwErrorCode *errorCode)
 Get the minimum wire section of the current terminal in square millimeter (mm²). More...
 
EwErrorCode setMinimumWireSection (DOUBLE dMinSection)
 Set the minimum wire section of the current terminal in square millimeter (mm²). More...
 

Detailed Description

Use this interface to manage ComponentTerminal inside a project.

Since
2018 SP0

Member Function Documentation

◆ getCircuitID()

LONG IEwProjectComponentTerminalX::getCircuitID ( EwErrorCode *  errorCode)

Return the circuit ID of the current terminal.

Since
2023 SP0
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 circuit ID of the current terminal.

◆ getIndex()

LONG IEwProjectComponentTerminalX::getIndex ( EwErrorCode *  errorCode)

Get the index of the current terminal.

Since
2023 SP0
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 terminal index.

◆ getMark()

BSTR IEwProjectComponentTerminalX::getMark ( EwErrorCode *  errorCode)

Get the mark of the current terminal.

Since
2023 SP0
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 of mark the current terminal.

◆ getMaximumWireNumber()

LONG IEwProjectComponentTerminalX::getMaximumWireNumber ( EwErrorCode *  errorCode)

Get the maximum number of wires than can be connected to the current terminal.

Since
2023 SP0
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 maximum number of wires than can be connected to the current terminal.

◆ getMaximumWireSection()

DOUBLE IEwProjectComponentTerminalX::getMaximumWireSection ( EwErrorCode *  errorCode)

Get the maximum wire section of the current terminal in square millimeter (mm²).

Since
2023 SP0
Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if an error occurred
  • EW_INVALID_OBJECT if object is not initialized
Returns
Will contain the maximum wire section of the current terminal in square millimeter (mm²).

◆ getMinimumWireSection()

DOUBLE IEwProjectComponentTerminalX::getMinimumWireSection ( EwErrorCode *  errorCode)

Get the minimum wire section of the current terminal in square millimeter (mm²).

Since
2023 SP0
Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if an error occurred
  • EW_INVALID_OBJECT if object is not initialized
Returns
Will contain the minimum wire section of the current terminal in square millimeter (mm²).

◆ getMnemonic()

BSTR IEwProjectComponentTerminalX::getMnemonic ( EwErrorCode *  errorCode)

Get the mnemonic of the current terminal.

Since
2023 SP0
Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if an error occurred
  • EW_INVALID_OBJECT if object is not initialized
Returns
will contain the mnemonic of the current terminal.

◆ getOrientation()

EwPointOrientation IEwProjectComponentTerminalX::getOrientation ( EwErrorCode *  errorCode)

Get the EwPointOrientation enum type of the current terminal.

Since
2023 SP0
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 EwPointOrientation enum type of the current terminal.

◆ getUtilization()

BSTR IEwProjectComponentTerminalX::getUtilization ( EwErrorCode *  errorCode)

Get the utilization text of the current terminal.

Since
2023 SP0
Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if an error occurred
  • EW_INVALID_OBJECT if object is not initialized
Returns
will contain the utilization text of the current terminal.

◆ getWireTerminationType()

IEwWireTerminationTypeX IEwProjectComponentTerminalX::getWireTerminationType ( EwErrorCode *  errorCode)

Get the termination type of the current terminal.

Since
2023 SP0
Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if an error occurred
  • EW_INVALID_OBJECT if object is not initialized
  • EW_OBJECT_NOT_FOUND if object does not exist
Returns
will contain the termination type of the current terminal.

◆ setMark()

EwErrorCode IEwProjectComponentTerminalX::setMark ( BSTR  sTerminalMark)

Set the mark of the current terminal.

Since
2023 SP0
Parameters
[in]sTerminalMarkThe mark you want to set.
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 sTerminalMark length is is higher than > 150

◆ setMaximumWireNumber()

EwErrorCode IEwProjectComponentTerminalX::setMaximumWireNumber ( LONG  lMaxWire)

Set the maximum number of wires than can be connected to the current terminal.

Since
2023 SP0
Parameters
[in]lMaxWireThe maximum number of wires you want to set (0 is included)
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_BAD_INPUTS if lMaxWire is negative
  • EW_INVALID_OBJECT if object is not initialized

◆ setMaximumWireSection()

EwErrorCode IEwProjectComponentTerminalX::setMaximumWireSection ( DOUBLE  dMaxSection)

Set the maximum wire section of the current terminal in square millimeter (mm²).

Since
2023 SP0
Parameters
[in]dMaxSectionThe maximum wire section you want to set in square millimeter (mm²).
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_INPUTS if dMaxSection is negative

◆ setMinimumWireSection()

EwErrorCode IEwProjectComponentTerminalX::setMinimumWireSection ( DOUBLE  dMinSection)

Set the minimum wire section of the current terminal in square millimeter (mm²).

Since
2023 SP0
Parameters
[in]dMinSectionThe minimum wire section you want to set in square millimeter (mm²).
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_INPUTS if dMinSection is negative

◆ setMnemonic()

EwErrorCode IEwProjectComponentTerminalX::setMnemonic ( BSTR  strMnemonic)

Set the mnemonic of the current terminal.

Since
2023 SP0
Parameters
[in]strMnemonicThe mnemonic you want to set.
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 strMnemonic length is higher than 70

◆ setOrientation()

EwErrorCode IEwProjectComponentTerminalX::setOrientation ( EwPointOrientation  ePointOrientation)

Set the EwPointOrientation enum type of the current terminal.

Since
2023 SP0
Parameters
[in]ePointOrientationthe orientation point to set.
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

◆ setUtilization()

EwErrorCode IEwProjectComponentTerminalX::setUtilization ( BSTR  strUtilization)

Set the utilization text of the current terminal.

Since
2023 SP0
Parameters
[in]strUtilizationThe utilization text you want to set.
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 strUtilization length is is higher than 255

◆ setWireTerminationType()

EwErrorCode IEwProjectComponentTerminalX::setWireTerminationType ( LONG  lWireTerminationTypeID)

Set a termination type to the current terminal.

Since
2023 SP0
Parameters
[in]lWireTerminationTypeIDThe termination type code ID of the termination 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
  • EW_INVALID_OBJECT if object is not initialized
  • EW_BAD_INPUT if lWireTerminationTypeID is negative
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: IEwProjectComponentTerminalX 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