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
IEwProjectWireX Interface Reference

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

Inheritance diagram for IEwProjectWireX:
[legend]

Public Member Functions

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...
 
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...
 
EwErrorCode setLength (DOUBLE dLength)
 
BSTR getLinearMass (EwErrorCode *errorCode)
 Get the linear mass (density) of this wire. More...
 
EwErrorCode setLinearMass (BSTR strLinearMass)
 Set the linear mass (density) of this wire. More...
 
EwErrorCode setHarnessID (long lHarnessID)
 Set the Harness ID of this wire. More...
 
LONG getHarnessID (EwErrorCode *errorCode)
 Get the Harness ID associated at the current wire. More...
 
DOUBLE getLength (EwErrorCode *pErrorCode)
 Get the lenght of the current wire. More...
 
EwErrorCode setDiameter (DOUBLE dValue)
 Set the diameter of this wire. More...
 
DOUBLE getDiameter (EwErrorCode *errorCode)
 Get the diameter of this wire. More...
 
EwErrorCode setSectionOrGauge (BSTR strValue)
 Set the section or gauge of this wire. More...
 
BSTR getSectionOrGauge (EwErrorCode *errorCode)
 Get the section or gauge of this wire. More...
 
EwErrorCode setWireSizeStandard (EwWireSizeStandard eWireSizeStandard)
 Set the wire size standard enum type of this wire. More...
 
EwWireSizeStandard getWireSizeStandard (EwErrorCode *errorCode)
 Get the wire size standard enum type of this wire. More...
 
EwErrorCode setSignal (BSTR strValue)
 Set the signal of this wire. More...
 
BSTR getSignal (EwErrorCode *errorCode)
 Get the signal of this wire. 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 wire inside a project.

Since
2018 SP0

Member Function Documentation

◆ getDiameter()

DOUBLE IEwProjectWireX::getDiameter ( EwErrorCode *  errorCode)

Get the diameter of this wire.

Since
2021 SP0
Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_INVALID_OBJECT current object is invalid.
  • EW_UNDEFINED_ERROR if another error occurred
Returns
a diameter of this wire

◆ getHarnessID()

LONG IEwProjectWireX::getHarnessID ( EwErrorCode *  errorCode)

Get the Harness ID associated at the current wire.

Return -1 if the current wire is not associated to an harness.

Since
2021 SP0
Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR No error detected
  • EW_INVALID_OBJECT current object is invalid
  • EW_UNDEFINED_ERROR if another error occurred.
Returns
the Harness ID associated with the wire.

◆ getLength()

DOUBLE IEwProjectWireX::getLength ( EwErrorCode *  pErrorCode)

Get the lenght of the current wire.

Since
2021 SP0.
Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred.
  • EW_INVALID_OBJECT current object is invalid.
  • EW_NO_ERROR No error detected.
Returns
lenght of wire.

◆ getLinearMass()

BSTR IEwProjectWireX::getLinearMass ( EwErrorCode *  errorCode)

Get the linear mass (density) of this wire.

Since
2020 SP0
Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred
Returns
a string with linear mass (density) of this wire

◆ getSectionOrGauge()

BSTR IEwProjectWireX::getSectionOrGauge ( EwErrorCode *  errorCode)

Get the section or gauge of this wire.

Since
2021 SP0
Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_INVALID_OBJECT current object is invalid.
  • EW_UNDEFINED_ERROR if another error occurred
Returns
a section or gauge of this wire

◆ getSignal()

BSTR IEwProjectWireX::getSignal ( EwErrorCode *  errorCode)

Get the signal of this wire.

Since
2021 SP0
Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_INVALID_OBJECT current object is invalid.
  • EW_UNDEFINED_ERROR if another error occurred
Returns
a signal of this wire

◆ getTag()

BSTR IEwProjectWireX::getTag ( EwErrorCode *  errorCode)

Get the mark of this object.

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

◆ getTagMode()

EwTagMode IEwProjectWireX::getTagMode ( EwErrorCode *  errorCode)

Get the mark mode of this object.

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

◆ getTagNumber()

long IEwProjectWireX::getTagNumber ( EwErrorCode *  errorCode)

Get the mark number of this object.

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

◆ getTagRoot()

BSTR IEwProjectWireX::getTagRoot ( EwErrorCode *  errorCode)

Get the mark root of this object.

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

◆ getUserData()

BSTR IEwProjectWireX::getUserData ( LONG  nUserDataNumber,
EwErrorCode *  errorCode 
)

Get user data of the object.

Parameters
[in]nUserDataNumbernumber of the user data
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR No error detected
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_OUT_OF_SCOPE number out of the scope supported by the method
  • EW_INVALID_OBJECT current object is invalid.
Returns
value of the user data requested

◆ getWireSizeStandard()

EwWireSizeStandard IEwProjectWireX::getWireSizeStandard ( EwErrorCode *  errorCode)

Get the wire size standard enum type of this wire.

Since
2021 SP0
Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_INVALID_OBJECT current object is invalid.
  • EW_UNDEFINED_ERROR if another error occurred
Returns
a wire size standard enum type of this wire

◆ isTagUnique()

VARIANT_BOOL IEwProjectWireX::isTagUnique ( EwErrorCode *  errorCode)

Returns true or false if mark is unique.

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

◆ setDiameter()

EwErrorCode IEwProjectWireX::setDiameter ( DOUBLE  dValue)

Set the diameter of this wire.

Since
2021 SP0
Parameters
[in]dValuenew diameter
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_INVALID_OBJECT current object is invalid.
  • EW_UNDEFINED_ERROR if another error occurred

◆ setHarnessID()

EwErrorCode IEwProjectWireX::setHarnessID ( long  lHarnessID)

Set the Harness ID of this wire.

Wire will be added to the harness after calling update or insert. Harness must exists to be able to set the ID. Setting the ID to -1 will remove the wire from the harness.

Since
2021 SP0
Parameters
[in]lHarnessIDThe Harness id to add.
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_BAD_INPUTS if the lHarnessID is not found or if the wire is already associate t a cable.
  • EW_INVALID_OBJECT current object is invalid
  • EW_UNDEFINED_ERROR if another error occurred

◆ setLength()

EwErrorCode IEwProjectWireX::setLength ( DOUBLE  dLength)

◆ setLinearMass()

EwErrorCode IEwProjectWireX::setLinearMass ( BSTR  strLinearMass)

Set the linear mass (density) of this wire.

Since
2020 SP0
Parameters
[in]strLinearMassThe linear mass (density) you want to set
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_INVALID_OBJECT current object is invalid.
  • EW_UNDEFINED_ERROR if another error occurred

◆ setNextTagNumber()

EwErrorCode IEwProjectWireX::setNextTagNumber ( )

Set the next number to have a unique mark.

Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR No error detected
  • EW_NO_DATA if no next unique tag number has been found with the specified formula
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT current object is invalid.

◆ setSectionOrGauge()

EwErrorCode IEwProjectWireX::setSectionOrGauge ( BSTR  strValue)

Set the section or gauge of this wire.

Since
2021 SP0
Parameters
[in]strValuenew section or gauge
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_INVALID_OBJECT current object is invalid.
  • EW_UNDEFINED_ERROR if another error occurred

◆ setSignal()

EwErrorCode IEwProjectWireX::setSignal ( BSTR  strValue)

Set the signal of this wire.

Since
2021 SP0
Parameters
[in]strValuenew signal
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_INVALID_OBJECT current object is invalid.
  • EW_UNDEFINED_ERROR if another error occurred

◆ setTag()

EwErrorCode IEwProjectWireX::setTag ( BSTR  strValue)

Set the mark of this object.

if markmode is auto, markmode is changed to manual

Parameters
[in]strValuevalue to set
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR No error detected
  • EW_INVALID_OBJECT if object is not initialized or this object is a Terminal strip
  • EW_BAD_INPUTS if strValue is empty
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT current object is invalid.

◆ setTagMode()

EwErrorCode IEwProjectWireX::setTagMode ( EwTagMode  eTagMode)

Set the mark mode of this object.

if we set markmode to auto, we calculate a new unique mark number and we update the mark

Parameters
[in]eTagModeenumeration value to set
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR No error detected
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT current object is invalid.

◆ setTagNumber()

EwErrorCode IEwProjectWireX::setTagNumber ( long  lValue)

Set the mark number of this object.

if we change tag number and mark mode is auto, we calculate a new unique mark number and we update the mark (mark is always unique) Returns error if generated mark is not unique.

Parameters
[in]lValuevalue to set
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR No error detected
  • EW_BAD_INPUTS if generated mark is not unique or negative.
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT current object is invalid.

◆ setTagRoot()

EwErrorCode IEwProjectWireX::setTagRoot ( BSTR  strValue)

Set the mark root of this object.

if we change root and mark mode is auto, we calculate a new unique mark number and we update the mark (mark is always unique)

Parameters
[in]strValuevalue to set
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR No error detected
  • EW_NO_DATA if no next unique tag number has been found with the specified formula
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT current object is invalid.

◆ setUserData()

EwErrorCode IEwProjectWireX::setUserData ( LONG  nUserDataNumber,
BSTR  strValue 
)

Set user data of the object.

Parameters
[in]nUserDataNumbernumber of the user data
[in]strValuevalue to set
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR No error detected
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_OUT_OF_SCOPE number out of the scope supported by the method
  • EW_INVALID_OBJECT current object is invalid.

◆ setWireSizeStandard()

EwErrorCode IEwProjectWireX::setWireSizeStandard ( EwWireSizeStandard  eWireSizeStandard)

Set the wire size standard enum type of this wire.

Since
2021 SP0
Parameters
[in]eWireSizeStandardenum type of wire
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_INVALID_OBJECT current object is invalid.
  • EW_UNDEFINED_ERROR if another error occurred
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: IEwProjectWireX 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