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
Collapse IEwObjectBaseXIEwObjectBaseX
Expand IEwEnvironmentObjectXIEwEnvironmentObjectX
Collapse IEwObjectXIEwObjectX
IEwClassificationX
IEwProjectComponentCircuitX
IEwProjectConfigurationX
IEwProjectEntity3DX
IEwProjectInputOutputX
IEwProjectManufacturerPartX
IEwProjectMultilingualTextX
IEwProjectPrintConfigX
IEwProjectReportX
IEwProjectSymbolX
Collapse IEwProjectTagObjectXIEwProjectTagObjectX
IEwProjectBookX
IEwProjectCableX
IEwProjectComponentX
IEwProjectFileX
IEwProjectFolderX
IEwProjectFunctionX
IEwProjectHarnessX
IEwProjectLocationX
IEwProjectWireStyleGroupX
IEwProjectWireStyleX
IEwProjectWireX
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
IEwProjectCableX Interface Reference

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

Inheritance diagram for IEwProjectCableX:
Inheritance graph

Public Member Functions

EwErrorCode setLength (DOUBLE dLength)
 
BSTR getArticleNumber (EwErrorCode *errorCode)
 Get the article number. More...
 
EwErrorCode setArticleNumber (BSTR strArticleNumber)
 Set the article number. More...
 
BSTR getManufacturer (EwErrorCode *errorCode)
 Get the manufacturer of the cable. More...
 
BSTR getReference (EwErrorCode *errorCode)
 Get the reference of the cable. More...
 
LONG getCoreCount (EwErrorCode *errorCode)
 Get cable core count. More...
 
EwErrorCode setCoreStubs (LONG nCoreIdx, DOUBLE dStubLengthFrom, DOUBLE dStubLengthTo)
 Set lengths of cable core stubs. More...
 
BSTR getExternalID (EwErrorCode *errorCode)
 Get external identifier of this cable. More...
 
EwErrorCode setExternalID (BSTR strExternalID)
 Set the external identifier of this cable. More...
 
BSTR getLinearMass (EwErrorCode *errorCode)
 Get the linear mass (density) of this cable. More...
 
EwErrorCode setLinearMass (BSTR strLinearMass)
 Set the linear mass (density) of this cable. More...
 
EwErrorCode setHarnessID (long lHarnessID)
 Set the Harness ID of this cable. More...
 
LONG getHarnessID (EwErrorCode *errorCode)
 Get the Harness ID associated with the current cable. More...
 
DOUBLE getVoltageDrop (EwErrorCode *errorCode)
 Get the voltage drop associated with the current cable. More...
 
EwErrorCode setVoltageDrop (DOUBLE dVoltageDrop)
 Set the voltage drop associated with the current cable. More...
 
EwErrorCode setFamily (BSTR strFamily)
 Set the family associated with the current cable. More...
 
BSTR getFamily (EwErrorCode *errorCode)
 Get the family associated with the current cable. More...
 
EwErrorCode setSupplierName (BSTR strSupplierName)
 Set the supplier name associated with the current cable. More...
 
BSTR getSupplierName (EwErrorCode *errorCode)
 Get the supplier name associated with the current cable. More...
 
EwErrorCode setDiameter (DOUBLE dDiameter)
 Set the diameter associated with the current cable. More...
 
DOUBLE getDiameter (EwErrorCode *errorCode)
 Get the diameter associated with the current cable. More...
 
EwErrorCode setBendRadius (DOUBLE dBendRadius)
 Set the bend radius associated with the current cable. More...
 
DOUBLE getBendRadius (EwErrorCode *errorCode)
 Get the bend radius associated with the current cable. More...
 
EwErrorCode setStockNumber (BSTR strStockNumber)
 Set the stock number associated with the current cable. More...
 
BSTR getStockNumber (EwErrorCode *errorCode)
 Get the stock number associated with the current cable. More...
 
EwErrorCode set3dOrigin (BSTR str3dOrigin)
 Set the 3D Orign associated with the current cable. More...
 
BSTR get3dOrigin (EwErrorCode *errorCode)
 Get the 3D Orign associated with the current cable. More...
 
EwErrorCode set3dDestination (BSTR str3dDestination)
 Set the 3D destination associated with the current cable. More...
 
BSTR get3dDestination (EwErrorCode *errorCode)
 Get the 3D Destination associated with the current cable. More...
 
EwErrorCode setDoCalculation (VARIANT_BOOL bDoCalculation)
 Set the calculation associated with the current cable. More...
 
VARIANT_BOOL getDoCalculation (EwErrorCode *errorCode)
 Get the calculation associated with the current cable. More...
 
EwErrorCode setStandard (BSTR strStandard)
 Set the standard associated with the current cable. More...
 
BSTR getStandard (EwErrorCode *errorCode)
 Get the standard associated with the current cable. More...
 
EwErrorCode setAppliedVoltage (DOUBLE dAppliedVoltage)
 Set the applied voltage associated with the current cable. More...
 
DOUBLE getAppliedVoltage (EwErrorCode *errorCode)
 Get the applied voltage associated with the current cable. More...
 
EwErrorCode setFullLoadCurrent (DOUBLE dFullLoadCurrent)
 Set the full load current associated with the current cable. More...
 
DOUBLE getFullLoadCurrent (EwErrorCode *errorCode)
 Get the full load current associated with the current cable. More...
 
EwErrorCode setInRushFactor (DOUBLE dInRushFactor)
 Set the rush factor associated with the current cable. More...
 
DOUBLE getInRushFactor (EwErrorCode *errorCode)
 Get the rush factor associated with the current cable. More...
 
EwErrorCode setUpStreamLocationID (LONG lUpStreamLocationID)
 Set the up stream location associated with the current cable. More...
 
LONG getUpStreamLocationID (EwErrorCode *errorCode)
 Get the up stream location associated with the current cable. More...
 
EwErrorCode setDownStreamLocationID (LONG lDownStreamLocationID)
 Set the down stream location associated with the current cable. More...
 
LONG getDownStreamLocationID (EwErrorCode *errorCode)
 Get the down stream location associated with the current cable. More...
 
EwErrorCode setFunctionID (LONG lFunctionID)
 Set the function ID associated with the current cable. More...
 
LONG getFunctionID (EwErrorCode *errorCode)
 Get the function ID associated with the current cable. More...
 
BSTR getColorCode (EwErrorCode *errorCode)
 Get the color code of this cable. More...
 
EwErrorCode setColorCode (BSTR strColorCode)
 Set the color code of this cable. More...
 
- Public Member Functions inherited from IEwProjectTagObjectX
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...
 
EwErrorCode setTranslatedData (LONG nUserDataNumber, BSTR strLanguage, BSTR strValue)
 Set the value of a translated text. More...
 
BSTR getTranslatedData (LONG nUserDataNumber, BSTR strLanguage, EwErrorCode *errorCode)
 Get the value of a translated text. 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...
 
IEwObjectX duplicate (EwErrorCode *errorCode)
 Duplicate current project 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 a cable inside a project.

Since
2018 SP0

Member Function Documentation

◆ get3dDestination()

BSTR IEwProjectCableX::get3dDestination ( EwErrorCode *  errorCode)

Get the 3D Destination associated with the current cable.

Since
2021 SP0
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 No error detected
Returns
3D destination associated with the current cable.

◆ get3dOrigin()

BSTR IEwProjectCableX::get3dOrigin ( EwErrorCode *  errorCode)

Get the 3D Orign associated with the current cable.

Since
2021 SP0
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 No error detected
Returns
3D Orign associated with the current cable.

◆ getAppliedVoltage()

DOUBLE IEwProjectCableX::getAppliedVoltage ( EwErrorCode *  errorCode)

Get the applied voltage associated with the current cable.

Since
2021 SP0
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 No error detected
Returns
applied voltage associated with the current cable.

◆ getArticleNumber()

BSTR IEwProjectCableX::getArticleNumber ( EwErrorCode *  errorCode)

Get the article number.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR No error detected
  • EW_UNDEFINED_ERROR if another error occurred
Returns
the string article number

◆ getBendRadius()

DOUBLE IEwProjectCableX::getBendRadius ( EwErrorCode *  errorCode)

Get the bend radius associated with the current cable.

Since
2022 SP0
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 No error detected
Returns
bend radius associated with the current cable.

◆ getColorCode()

BSTR IEwProjectCableX::getColorCode ( EwErrorCode *  errorCode)

Get the color code of this cable.

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 color code of this cable reference

◆ getCoreCount()

LONG IEwProjectCableX::getCoreCount ( EwErrorCode *  errorCode)

Get cable core count.

Since
2018 SP3
Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR No error detected
  • EW_INVALID_OBJECT if object is not initialized
Returns
Number of cable cores

◆ getDiameter()

DOUBLE IEwProjectCableX::getDiameter ( EwErrorCode *  errorCode)

Get the diameter associated with the current cable.

Since
2022 SP0
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 No error detected
Returns
diameter associated with the current cable.

◆ getDoCalculation()

VARIANT_BOOL IEwProjectCableX::getDoCalculation ( EwErrorCode *  errorCode)

Get the calculation associated with the current cable.

Since
2021 SP2
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 No error detected
Returns
calculation associated with the current cable
  • true if calculation is check
  • false if calculation is uncheck

◆ getDownStreamLocationID()

LONG IEwProjectCableX::getDownStreamLocationID ( EwErrorCode *  errorCode)

Get the down stream location associated with the current cable.

Since
2022 SP0
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 No error detected
Returns
down stream location associated with the current cable.

◆ getExternalID()

BSTR IEwProjectCableX::getExternalID ( EwErrorCode *  errorCode)

Get external identifier of this cable.

Since
2019
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 external identifier in this cable

◆ getFamily()

BSTR IEwProjectCableX::getFamily ( EwErrorCode *  errorCode)

Get the family associated with the current cable.

Since
2021 SP0
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 No error detected
Returns
family associated with the current cable.

◆ getFullLoadCurrent()

DOUBLE IEwProjectCableX::getFullLoadCurrent ( EwErrorCode *  errorCode)

Get the full load current associated with the current cable.

Since
2021 SP0
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 No error detected
Returns
full load associated with the current cable.

◆ getFunctionID()

LONG IEwProjectCableX::getFunctionID ( EwErrorCode *  errorCode)

Get the function ID associated with the current cable.

Since
2022 SP0
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 No error detected
Returns
function ID associated with the current cable.

◆ getHarnessID()

LONG IEwProjectCableX::getHarnessID ( EwErrorCode *  errorCode)

Get the Harness ID associated with the current cable.

Return -1 if the current cable is not associated to a harness.

Since
2021 SP0
Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR No error detected
  • EW_INVALID_OBJECT if object is not initialized
Returns
the Harness ID associated with the current cable.

◆ getInRushFactor()

DOUBLE IEwProjectCableX::getInRushFactor ( EwErrorCode *  errorCode)

Get the rush factor associated with the current cable.

Since
2021 SP2
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 No error detected
Returns
rush factor associated with the current cable.

◆ getLinearMass()

BSTR IEwProjectCableX::getLinearMass ( EwErrorCode *  errorCode)

Get the linear mass (density) of this cable.

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 cable

◆ getManufacturer()

BSTR IEwProjectCableX::getManufacturer ( EwErrorCode *  errorCode)

Get the manufacturer of the cable.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR No error detected
  • EW_UNDEFINED_ERROR if another error occurred
Returns
the string article number

◆ getReference()

BSTR IEwProjectCableX::getReference ( EwErrorCode *  errorCode)

Get the reference of the cable.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR No error detected
  • EW_UNDEFINED_ERROR if another error occurred
Returns
the string article number

◆ getStandard()

BSTR IEwProjectCableX::getStandard ( EwErrorCode *  errorCode)

Get the standard associated with the current cable.

Since
2021 SP0
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 No error detected
Returns
standard associated with the current cable.

◆ getStockNumber()

BSTR IEwProjectCableX::getStockNumber ( EwErrorCode *  errorCode)

Get the stock number associated with the current cable.

Since
2021 SP0
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 No error detected
Returns
stock number associated with the current cable.

◆ getSupplierName()

BSTR IEwProjectCableX::getSupplierName ( EwErrorCode *  errorCode)

Get the supplier name associated with the current cable.

Since
2021 SP0
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 No error detected
Returns
supplier name associated with the current cable.

◆ getUpStreamLocationID()

LONG IEwProjectCableX::getUpStreamLocationID ( EwErrorCode *  errorCode)

Get the up stream location associated with the current cable.

Since
2022 SP0
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 No error detected
Returns
up stream location associated with the current cable.

◆ getVoltageDrop()

DOUBLE IEwProjectCableX::getVoltageDrop ( EwErrorCode *  errorCode)

Get the voltage drop associated with the current cable.

Since
2021 SP0
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 No error detected
Returns
voltage drop associated with the current cable.

◆ set3dDestination()

EwErrorCode IEwProjectCableX::set3dDestination ( BSTR  str3dDestination)

Set the 3D destination associated with the current cable.

Since
2021 SP0
Parameters
[in]str3dDestinationnew 3D destination.
Returns
EwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT if object is not initialized
  • EW_NO_ERROR No error detected

◆ set3dOrigin()

EwErrorCode IEwProjectCableX::set3dOrigin ( BSTR  str3dOrigin)

Set the 3D Orign associated with the current cable.

Since
2021 SP0
Parameters
[in]str3dOriginnew 3D origin
Returns
EwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT if object is not initialized
  • EW_NO_ERROR No error detected

◆ setAppliedVoltage()

EwErrorCode IEwProjectCableX::setAppliedVoltage ( DOUBLE  dAppliedVoltage)

Set the applied voltage associated with the current cable.

Since
2021 SP0
Parameters
[in]dAppliedVoltagenew applied voltage
Returns
EwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT if object is not initialized
  • EW_NO_ERROR No error detected

◆ setArticleNumber()

EwErrorCode IEwProjectCableX::setArticleNumber ( BSTR  strArticleNumber)

Set the article number.

Parameters
[in]strArticleNumberstring to set on the article number
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR No error detected
  • EW_UNDEFINED_ERROR if another error occurred

◆ setBendRadius()

EwErrorCode IEwProjectCableX::setBendRadius ( DOUBLE  dBendRadius)

Set the bend radius associated with the current cable.

Since
2022 SP0
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 dDidBendRadiusameter is invalid (if is < 0)
  • EW_NO_ERROR No error detected

◆ setColorCode()

EwErrorCode IEwProjectCableX::setColorCode ( BSTR  strColorCode)

Set the color code of this cable.

Parameters
[in]strColorCodeThe color code 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

◆ setCoreStubs()

EwErrorCode IEwProjectCableX::setCoreStubs ( LONG  nCoreIdx,
DOUBLE  dStubLengthFrom,
DOUBLE  dStubLengthTo 
)

Set lengths of cable core stubs.

Since
2018 SP3
Parameters
[in]nCoreIdxCable core index, starts with 0
[in]dStubLengthFromFROM stub length
[in]dStubLengthToTO stub length
Returns
errorCode EwErrorCode enum type, can be:
  • EW_NO_ERROR No error detected
  • EW_INVALID_OBJECT if object is not initialized
  • EW_OBJECT_NOT_FOUND if core index is out of range

◆ setDiameter()

EwErrorCode IEwProjectCableX::setDiameter ( DOUBLE  dDiameter)

Set the diameter associated with the current cable.

Since
2022 SP0
Parameters
[in]dDiameternew diameter
Returns
errorCode 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 dDiameter is invalid (if is < 0)
  • EW_NO_ERROR No error detected
diameter associated with the current cable.

◆ setDoCalculation()

EwErrorCode IEwProjectCableX::setDoCalculation ( VARIANT_BOOL  bDoCalculation)

Set the calculation associated with the current cable.

Since
2021 SP2
Parameters
[in]bDoCalculationdo the calculation
Returns
EwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT if object is not initialized
  • EW_NO_ERROR No error detected

◆ setDownStreamLocationID()

EwErrorCode IEwProjectCableX::setDownStreamLocationID ( LONG  lDownStreamLocationID)

Set the down stream location associated with the current cable.

Since
2022 SP0
Parameters
[in]lDownStreamLocationIDnew down stream location
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 lUpStreamLocation is invalid (not found or not -1)
  • EW_NO_ERROR No error detected

◆ setExternalID()

EwErrorCode IEwProjectCableX::setExternalID ( BSTR  strExternalID)

Set the external identifier of this cable.

Since
2019
Parameters
[in]strExternalIDThe external identifier you want to set
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred

◆ setFamily()

EwErrorCode IEwProjectCableX::setFamily ( BSTR  strFamily)

Set the family associated with the current cable.

Since
2021 SP0
Parameters
[in]strFamilynew Family name
Returns
errorCode EwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT if object is not initialized
  • EW_NO_ERROR No error detected

◆ setFullLoadCurrent()

EwErrorCode IEwProjectCableX::setFullLoadCurrent ( DOUBLE  dFullLoadCurrent)

Set the full load current associated with the current cable.

Since
2021 SP0
Parameters
[in]dFullLoadCurrentnew full load current
Returns
EwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT if object is not initialized
  • EW_NO_ERROR No error detected

◆ setFunctionID()

EwErrorCode IEwProjectCableX::setFunctionID ( LONG  lFunctionID)

Set the function ID associated with the current cable.

Since
2022 SP0
Parameters
[in]lFunctionIDnew function ID
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 lFunctionID is invalid (not found or not -1)
  • EW_NO_ERROR No error detected

◆ setHarnessID()

EwErrorCode IEwProjectCableX::setHarnessID ( long  lHarnessID)

Set the Harness ID of this cable.

Cable 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 cable 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 invalid (not found or not -1)
  • EW_INVALID_OBJECT if object is not initialized
  • EW_UNDEFINED_ERROR if another error occurred

◆ setInRushFactor()

EwErrorCode IEwProjectCableX::setInRushFactor ( DOUBLE  dInRushFactor)

Set the rush factor associated with the current cable.

Since
2021 SP2
Parameters
[in]dInRushFactornew rush factor
Returns
EwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT if object is not initialized
  • EW_NO_ERROR No error detected

◆ setLength()

EwErrorCode IEwProjectCableX::setLength ( DOUBLE  dLength)

◆ setLinearMass()

EwErrorCode IEwProjectCableX::setLinearMass ( BSTR  strLinearMass)

Set the linear mass (density) of this cable.

Since
2020
Parameters
[in]strLinearMassThe linear mass (density) you want to set
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_BAD_INPUTS if the length of value is greater than maximum length of the field or units are not allowed
  • EW_UNDEFINED_ERROR if another error occurred

◆ setStandard()

EwErrorCode IEwProjectCableX::setStandard ( BSTR  strStandard)

Set the standard associated with the current cable.

Since
2021 SP0
Parameters
[in]strStandardnew standard
Returns
EwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT if object is not initialized
  • EW_NO_ERROR No error detected

◆ setStockNumber()

EwErrorCode IEwProjectCableX::setStockNumber ( BSTR  strStockNumber)

Set the stock number associated with the current cable.

Since
2021 SP0
Parameters
[in]strStockNumbernew stock number
Returns
EwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT if object is not initialized
  • EW_NO_ERROR No error detected

◆ setSupplierName()

EwErrorCode IEwProjectCableX::setSupplierName ( BSTR  strSupplierName)

Set the supplier name associated with the current cable.

Since
2021 SP0
Parameters
[in]strSupplierNamenew Supplier name
Returns
EwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT if object is not initialized
  • EW_NO_ERROR No error detected

◆ setUpStreamLocationID()

EwErrorCode IEwProjectCableX::setUpStreamLocationID ( LONG  lUpStreamLocationID)

Set the up stream location associated with the current cable.

Since
2022 SP0
Parameters
[in]lUpStreamLocationIDnew up stream location
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 lUpStreamLocation is invalid (not found or not -1)
  • EW_NO_ERROR No error detected

◆ setVoltageDrop()

EwErrorCode IEwProjectCableX::setVoltageDrop ( DOUBLE  dVoltageDrop)

Set the voltage drop associated with the current cable.

Since
2021 SP0
Parameters
[in]dVoltageDropnew Voltage
Returns
EwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT if object is not initialized
  • EW_NO_ERROR 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: IEwProjectCableX 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