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
Collapse Class ListClass List
Expand IEwAddInIEwAddIn
IEwAddinInternalX
Expand IEwAPIXIEwAPIX
Expand IEwApplicationSettingsXIEwApplicationSettingsX
Expand IEwApplicationXIEwApplicationX
Expand IEwArchiveEnvironmentXIEwArchiveEnvironmentX
Expand IEwCableCoreXIEwCableCoreX
Expand IEwCableReferenceManagerXIEwCableReferenceManagerX
Expand IEwCableReferenceXIEwCableReferenceX
Expand IEwCaptionBarControlXIEwCaptionBarControlX
Expand IEwCaptionBarXIEwCaptionBarX
Expand IEwClassificationManagerXIEwClassificationManagerX
Expand IEwClassificationXIEwClassificationX
Expand IEwClassXIEwClassX
IEwCommandContextX
Expand IEwCommandManagerXIEwCommandManagerX
Expand IEwCommandXIEwCommandX
Expand IEwDialogAlignPartsParametersSelectorXIEwDialogAlignPartsParametersSelectorX
Expand IEwDialogLocationSelectorXIEwDialogLocationSelectorX
Expand IEwDialogMacroSelectorXIEwDialogMacroSelectorX
Expand IEwDialogManufacturerPartOrderingXIEwDialogManufacturerPartOrderingX
Expand IEwDialogManufacturerPartSelectorXIEwDialogManufacturerPartSelectorX
Expand IEwDialogProgressXIEwDialogProgressX
Expand IEwDialogProjectManagerXIEwDialogProjectManagerX
Expand IEwDialogResumeXIEwDialogResumeX
Expand IEwDialogSummaryXIEwDialogSummaryX
Expand IEwDialogTaskXIEwDialogTaskX
Expand IEwDockingPaneManagerXIEwDockingPaneManagerX
Expand IEwDockingPaneXIEwDockingPaneX
Expand IEwDocumentManagerXIEwDocumentManagerX
Expand IEwDocumentXIEwDocumentX
Expand IEwEnvironmentObjectXIEwEnvironmentObjectX
Expand IEwEnvironmentXIEwEnvironmentX
IEwInteropFactoryX
Expand IEwLibraryManagerXIEwLibraryManagerX
Expand IEwLibraryXIEwLibraryX
Expand IEwLockStringXIEwLockStringX
Expand IEwManagerDialogXIEwManagerDialogX
Expand IEwManufacturerPartCircuitXIEwManufacturerPartCircuitX
Expand IEwManufacturerPartManagerXIEwManufacturerPartManagerX
Expand IEwManufacturerPartTerminalXIEwManufacturerPartTerminalX
Expand IEwManufacturerPartXIEwManufacturerPartX
Expand IEwMenuItemXIEwMenuItemX
Expand IEwMenuManagerXIEwMenuManagerX
Expand IEwMenuXIEwMenuX
Expand IEwNotificationDialogXIEwNotificationDialogX
Expand IEwObjectBaseXIEwObjectBaseX
IEwObjectDispatchX
Expand IEwObjectXIEwObjectX
Expand IEwPointXIEwPointX
Expand IEwProjectAutomaticArrowsXIEwProjectAutomaticArrowsX
Expand IEwProjectBookManagerXIEwProjectBookManagerX
Expand IEwProjectBookXIEwProjectBookX
Expand IEwProjectCableManagerXIEwProjectCableManagerX
Expand IEwProjectCableXIEwProjectCableX
Expand IEwProjectComponentCircuitXIEwProjectComponentCircuitX
Expand IEwProjectComponentManagerXIEwProjectComponentManagerX
Expand IEwProjectComponentTerminalXIEwProjectComponentTerminalX
Expand IEwProjectComponentXIEwProjectComponentX
Expand IEwProjectConfigurationXIEwProjectConfigurationX
Expand IEwProjectEntity3DManagerXIEwProjectEntity3DManagerX
Expand IEwProjectEntity3DXIEwProjectEntity3DX
Expand IEwProjectExcelAutomationXIEwProjectExcelAutomationX
Expand IEwProjectExportDWGFilesXIEwProjectExportDWGFilesX
Expand IEwProjectExportPDFXIEwProjectExportPDFX
Expand IEwProjectExportPDMXIEwProjectExportPDMX
Expand IEwProjectExportReportXIEwProjectExportReportX
Expand IEwProjectFileConfigurationManagerXIEwProjectFileConfigurationManagerX
Expand IEwProjectFileConfigurationXIEwProjectFileConfigurationX
Expand IEwProjectFileManagerXIEwProjectFileManagerX
Expand IEwProjectFileXIEwProjectFileX
Expand IEwProjectFolderManagerXIEwProjectFolderManagerX
Expand IEwProjectFolderXIEwProjectFolderX
Expand IEwProjectFunctionManagerXIEwProjectFunctionManagerX
Expand IEwProjectFunctionXIEwProjectFunctionX
Expand IEwProjectGenerateTSDrawingXIEwProjectGenerateTSDrawingX
Expand IEwProjectHarnessManagerXIEwProjectHarnessManagerX
Expand IEwProjectHarnessXIEwProjectHarnessX
Expand IEwProjectInputOutputManagerXIEwProjectInputOutputManagerX
Expand IEwProjectInputOutputXIEwProjectInputOutputX
Expand IEwProjectLocationManagerXIEwProjectLocationManagerX
Expand IEwProjectLocationXIEwProjectLocationX
Expand IEwProjectManagerXIEwProjectManagerX
IEwProjectManufacturerPartCircuitX
Expand IEwProjectManufacturerPartManagerXIEwProjectManufacturerPartManagerX
IEwProjectManufacturerPartTerminalX
Expand IEwProjectManufacturerPartXIEwProjectManufacturerPartX
Expand IEwProjectMultilingualTextFontXIEwProjectMultilingualTextFontX
Expand IEwProjectMultilingualTextManagerXIEwProjectMultilingualTextManagerX
Expand IEwProjectMultilingualTextXIEwProjectMultilingualTextX
Expand IEwProjectNumberDocumentsXIEwProjectNumberDocumentsX
Expand IEwProjectNumberMarksXIEwProjectNumberMarksX
Expand IEwProjectNumberWiresXIEwProjectNumberWiresX
Expand IEwProjectOptimizeWireOrderXIEwProjectOptimizeWireOrderX
Expand IEwProjectPrintConfigManagerXIEwProjectPrintConfigManagerX
Expand IEwProjectPrintConfigXIEwProjectPrintConfigX
Expand IEwProjectReportManagerXIEwProjectReportManagerX
Expand IEwProjectReportXIEwProjectReportX
Expand IEwProjectSnapshotManagerXIEwProjectSnapshotManagerX
Expand IEwProjectSnapshotXIEwProjectSnapshotX
Expand IEwProjectSymbolManagerXIEwProjectSymbolManagerX
Expand IEwProjectSymbolXIEwProjectSymbolX
Expand IEwProjectTagObjectXIEwProjectTagObjectX
Expand IEwProjectUpdateReplaceDataXIEwProjectUpdateReplaceDataX
Expand IEwProjectWireManagerXIEwProjectWireManagerX
Expand IEwProjectWireStyleGroupXIEwProjectWireStyleGroupX
Expand IEwProjectWireStyleManagerXIEwProjectWireStyleManagerX
Expand IEwProjectWireStyleXIEwProjectWireStyleX
Collapse IEwProjectWireXIEwProjectWireX
Expand IEwProjectXIEwProjectX
Expand IEwResumeRowXIEwResumeRowX
Expand IEwRibbonComboBoxControlXIEwRibbonComboBoxControlX
Expand IEwRibbonControlXIEwRibbonControlX
Expand IEwRibbonGroupXIEwRibbonGroupX
Expand IEwRibbonQuickAccessControlXIEwRibbonQuickAccessControlX
Expand IEwRibbonTabXIEwRibbonTabX
Expand IEwRibbonXIEwRibbonX
Expand IEwRightsManagerXIEwRightsManagerX
Expand IEwSaveDWGImageXIEwSaveDWGImageX
Expand IEwSelectorDialogXIEwSelectorDialogX
Expand IEwSymbolCircuitXIEwSymbolCircuitX
Expand IEwSymbolFiltersXIEwSymbolFiltersX
Expand IEwSymbolManagerXIEwSymbolManagerX
Expand IEwSymbolPointXIEwSymbolPointX
Expand IEwSymbolXIEwSymbolX
Expand IEwTerminalTypeManagerXIEwTerminalTypeManagerX
Expand IEwTerminalTypeXIEwTerminalTypeX
Expand IEwTitleBlockManagerXIEwTitleBlockManagerX
Expand IEwTitleBlockXIEwTitleBlockX
Expand IEwWireTerminationTypeManagerXIEwWireTerminationTypeManagerX
Expand IEwWireTerminationTypeXIEwWireTerminationTypeX
Expand IEwXLSBookXIEwXLSBookX
Expand IEwXLSSheetXIEwXLSSheetX
Expand IInteropFactoryXIInteropFactoryX
Class Index
Expand Class HierarchyClass Hierarchy
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
IEwProjectWireX Interface Reference

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

Inheritance diagram for IEwProjectWireX:
Inheritance graph

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 object. More...
 
EwErrorCode setLinearMass (BSTR strLinearMass)
 Set the linear mass (density) of this object. 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 *errorCode)
 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...
 
BSTR getColorCode (EwErrorCode *errorCode)
 Get the color code of this wire. More...
 
EwErrorCode setColorCode (BSTR strColorCode)
 Set the color code of this wire. More...
 
EwErrorCode setBendRadiusFactor (DOUBLE dBendRadiusFactor)
 Set the bend radius factor associated with the current wire. More...
 
DOUBLE getBendRadiusFactor (EwErrorCode *errorCode)
 Get the bend radius factor associated with the current wire. More...
 
EwErrorCode setBendRadius (DOUBLE dBendRadius)
 Set the bend radius in millimeter associated with the current object. More...
 
DOUBLE getBendRadius (EwErrorCode *errorCode)
 Get the bend radius in millimeter associated with the current object. More...
 
BSTR getPath (EwErrorCode *errorCode)
 Get the duct path of the current wire. More...
 
LONG getWireStyleID (EwErrorCode *errorCode)
 Get the EwWireStyleX object ID of the current wire. More...
 
BSTR getEquipotential (EwErrorCode *errorCode)
 Get the equipotential tag of this wire. More...
 
LONG getCableWireOrder (EwErrorCode *errorCode)
 Get the cabling order of the current wire. More...
 
LONG getCableID (EwErrorCode *errorCode)
 Get the cable ID associated to the current wire. More...
 
BSTR getOrigin (EwErrorCode *errorCode)
 Get the origin of this wire. More...
 
BSTR getDestination (EwErrorCode *errorCode)
 Get the destination of this wire. More...
 
BSTR getCableCoreDescription (EwErrorCode *errorCode)
 Get the cable core description of the current 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

◆ getBendRadius()

DOUBLE IEwProjectWireX::getBendRadius ( EwErrorCode *  errorCode)

Get the bend radius in millimeter associated with the current object.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT if object is not initialized
  • EW_NO_ERROR if no error detected
Returns
bend radius in millimeter associated with the current object.

◆ getBendRadiusFactor()

DOUBLE IEwProjectWireX::getBendRadiusFactor ( EwErrorCode *  errorCode)

Get the bend radius factor associated with the current wire.

Since
2023 SP0
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
bend radius factor associated with the current wire.

◆ getCableCoreDescription()

BSTR IEwProjectWireX::getCableCoreDescription ( EwErrorCode *  errorCode)

Get the cable core description of the current wire.

Since
2023 SP0
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
the cable core description of the current wire.

◆ getCableID()

LONG IEwProjectWireX::getCableID ( EwErrorCode *  errorCode)

Get the cable ID associated to the current wire.

Since
2023 SP0
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
the cable ID associated to the current wire.

◆ getCableWireOrder()

LONG IEwProjectWireX::getCableWireOrder ( EwErrorCode *  errorCode)

Get the cabling order of the current wire.

Since
2023 SP0
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
the cabling order of the current wire.

◆ getColorCode()

BSTR IEwProjectWireX::getColorCode ( EwErrorCode *  errorCode)

Get the color code of this wire.

Since
2023 SP0
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
Will contain the color code of this wire

◆ getDestination()

BSTR IEwProjectWireX::getDestination ( EwErrorCode *  errorCode)

Get the destination of this wire.

Since
2023 SP0
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
will contain the destination of the current wire

◆ getDiameter()

DOUBLE IEwProjectWireX::getDiameter ( EwErrorCode *  errorCode)

Get the diameter of this wire.

Since
2021 SP0
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 diameter of this wire

◆ getEquipotential()

BSTR IEwProjectWireX::getEquipotential ( EwErrorCode *  errorCode)

Get the equipotential tag of this wire.

Since
2023 SP0
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
Will contain the equipotential tag of the current 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_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT if current object is invalid.
  • EW_NO_ERROR if no error detected
Returns
the Harness ID associated with the wire.

◆ getLength()

DOUBLE IEwProjectWireX::getLength ( EwErrorCode *  errorCode)

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 if current object is invalid.
  • EW_NO_ERROR if no error detected.
Returns
lenght of wire.

◆ getLinearMass()

BSTR IEwProjectWireX::getLinearMass ( EwErrorCode *  errorCode)

Get the linear mass (density) of this object.

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

◆ getOrigin()

BSTR IEwProjectWireX::getOrigin ( EwErrorCode *  errorCode)

Get the origin of this wire.

Since
2023 SP0
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
will contain the origin of the current wire

◆ getPath()

BSTR IEwProjectWireX::getPath ( EwErrorCode *  errorCode)

Get the duct path of the current wire.

Since
2023 SP0
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
duct path of the current 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_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT current object is invalid.
  • EW_NO_ERROR if no error detected
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_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT if current object is invalid.
  • EW_NO_ERROR if no error detected
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_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT if current object is invalid.
  • EW_NO_ERROR if no error detected
Returns
a mark

◆ getTagMode()

EwTagMode IEwProjectWireX::getTagMode ( EwErrorCode *  errorCode)

Get the mark mode 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

◆ getTagNumber()

long IEwProjectWireX::getTagNumber ( EwErrorCode *  errorCode)

Get the mark number 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 number

◆ getTagRoot()

BSTR IEwProjectWireX::getTagRoot ( EwErrorCode *  errorCode)

Get the mark root 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 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_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT current object is invalid.
  • EW_OUT_OF_SCOPE number out of the scope supported by the method
  • EW_NO_ERROR if no error detected
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_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT if current object is invalid.
  • EW_NO_ERROR if no error detected
Returns
a wire size standard enum type of this wire

◆ getWireStyleID()

LONG IEwProjectWireX::getWireStyleID ( EwErrorCode *  errorCode)

Get the EwWireStyleX object ID of the current wire.

Since
2023 SP0
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
lLineTypeID is the EwWireStyleX object ID of the current wire.

◆ isTagUnique()

VARIANT_BOOL IEwProjectWireX::isTagUnique ( EwErrorCode *  errorCode)

Returns true or false if mark is unique.

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
true if the mark is unique.

◆ setBendRadius()

EwErrorCode IEwProjectWireX::setBendRadius ( DOUBLE  dBendRadius)

Set the bend radius in millimeter associated with the current object.

Parameters
[in]dBendRadiusnew bend radius
Returns
EwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT if object is not initialized
  • EW_BAD_INPUTS if the dBendRadius is invalid (dBendRadius must be strictly inferior to wire diameter)
  • EW_NO_ERROR if no error detected

◆ setBendRadiusFactor()

EwErrorCode IEwProjectWireX::setBendRadiusFactor ( DOUBLE  dBendRadiusFactor)

Set the bend radius factor associated with the current wire.

Since
2023 SP0 1 By default.
Parameters
[in]dBendRadiusFactornew bend radius factor
Returns
EwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT if current object is invalid.
  • EW_BAD_INPUTS if the dBendFactor is invalid (dBendFactor < 1)
  • EW_NO_ERROR if no error detected

◆ setColorCode()

EwErrorCode IEwProjectWireX::setColorCode ( BSTR  strColorCode)

Set the color code of this wire.

Since
2023 SP0
Parameters
[in]strColorCodeThe color code you want to set
Returns
EwErrorCode 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

◆ 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_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT if current object is invalid.
  • EW_NO_ERROR if no error detected

◆ 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_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT if current object is invalid
  • EW_BAD_INPUTS if the lHarnessID is not found or if the wire is already associate t a cable.
  • EW_NO_ERROR if no error detected

◆ setLength()

EwErrorCode IEwProjectWireX::setLength ( DOUBLE  dLength)

◆ setLinearMass()

EwErrorCode IEwProjectWireX::setLinearMass ( BSTR  strLinearMass)

Set the linear mass (density) of this object.

Parameters
[in]strLinearMassThe linear mass (density) you want to set
Returns
EwErrorCode 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

◆ setNextTagNumber()

EwErrorCode IEwProjectWireX::setNextTagNumber ( )

Set the next number to have a unique mark.

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

◆ 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_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT if current object is invalid.
  • EW_NO_ERROR if no error detected

◆ 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_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT if current object is invalid.
  • EW_NO_ERROR if no error detected

◆ 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_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT if object is not initialized or this object is a Terminal strip
  • EW_BAD_INPUTS if strValue is empty
  • EW_NO_ERROR if No error detected

◆ 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_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT if current object is invalid.
  • EW_NO_ERROR if no error detected

◆ 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_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT if current object is invalid.
  • EW_BAD_INPUTS if generated mark is not unique or negative.
  • EW_NO_ERROR if no error detected

◆ 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_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT if current object is invalid.
  • EW_NO_DATA if no next unique tag number has been found with the specified formula
  • EW_NO_ERROR if no error detected

◆ 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_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT current object is invalid.
  • EW_OUT_OF_SCOPE number out of the scope supported by the method
  • EW_NO_ERROR if no error detected

◆ 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_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT if current object is invalid.
  • EW_NO_ERROR if no error detected
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: 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) 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