Welcome
Expand Getting StartedGetting Started
Expand SOLIDWORKS API HelpSOLIDWORKS API Help
Collapse SOLIDWORKS Electrical API HelpSOLIDWORKS Electrical API Help
Expand Getting StartedGetting Started
Collapse ClassesClasses
Collapse Class ListClass List
Expand _DIEwProjectXEvents_DIEwProjectXEvents
Expand IEwAddInIEwAddIn
Expand IEwAPIXIEwAPIX
IEwApplicationReactorX
Expand IEwApplicationSettingsXIEwApplicationSettingsX
Expand IEwApplicationXIEwApplicationX
Expand IEwArchiveEnvironmentXIEwArchiveEnvironmentX
Expand IEwCableCoreXIEwCableCoreX
Expand IEwCableReferenceManagerXIEwCableReferenceManagerX
Expand IEwCableReferenceXIEwCableReferenceX
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 IEwEnvironmentXIEwEnvironmentX
Expand IEwInteropFactoryXIEwInteropFactoryX
Expand IEwLibraryManagerXIEwLibraryManagerX
Expand IEwLibraryXIEwLibraryX
Expand IEwLockStringXIEwLockStringX
Expand IEwManufacturerPartCircuitXIEwManufacturerPartCircuitX
Expand IEwManufacturerPartManagerXIEwManufacturerPartManagerX
Expand IEwManufacturerPartTerminalXIEwManufacturerPartTerminalX
Expand IEwManufacturerPartXIEwManufacturerPartX
Expand IEwObjectBaseXIEwObjectBaseX
Expand IEwPointXIEwPointX
Expand IEwProjectAutomaticArrowsXIEwProjectAutomaticArrowsX
Expand IEwProjectBookManagerXIEwProjectBookManagerX
IEwProjectBookX
Expand IEwProjectCableManagerXIEwProjectCableManagerX
Expand IEwProjectCableXIEwProjectCableX
Expand IEwProjectComponentCircuitXIEwProjectComponentCircuitX
Expand IEwProjectComponentManagerXIEwProjectComponentManagerX
IEwProjectComponentTerminalX
Expand IEwProjectComponentXIEwProjectComponentX
Expand IEwProjectConfigurationXIEwProjectConfigurationX
Expand IEwProjectEntity3DManagerXIEwProjectEntity3DManagerX
Expand IEwProjectEntity3DXIEwProjectEntity3DX
Expand IEwProjectExportDWGFilesXIEwProjectExportDWGFilesX
Expand IEwProjectExportPDMXIEwProjectExportPDMX
Expand IEwProjectExportReportXIEwProjectExportReportX
Expand IEwProjectFileManagerXIEwProjectFileManagerX
Expand IEwProjectFileXIEwProjectFileX
Expand IEwProjectFolderManagerXIEwProjectFolderManagerX
Expand IEwProjectFolderXIEwProjectFolderX
Expand IEwProjectFunctionManagerXIEwProjectFunctionManagerX
Expand IEwProjectFunctionXIEwProjectFunctionX
Expand IEwProjectGenerateTSDrawingXIEwProjectGenerateTSDrawingX
Expand IEwProjectHarnessManagerXIEwProjectHarnessManagerX
IEwProjectHarnessX
Expand IEwProjectLocationManagerXIEwProjectLocationManagerX
Expand IEwProjectLocationXIEwProjectLocationX
Expand IEwProjectManagerXIEwProjectManagerX
IEwProjectManufacturerPartCircuitX
Expand IEwProjectManufacturerPartManagerXIEwProjectManufacturerPartManagerX
IEwProjectManufacturerPartTerminalX
Expand IEwProjectManufacturerPartXIEwProjectManufacturerPartX
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 IEwProjectWireXIEwProjectWireX
Expand IEwProjectXIEwProjectX
Expand IEwResumeRowXIEwResumeRowX
Expand IEwRibbonControlXIEwRibbonControlX
Expand IEwRibbonGroupXIEwRibbonGroupX
Expand IEwRibbonTabXIEwRibbonTabX
Expand IEwRibbonXIEwRibbonX
Expand IEwRightsManagerXIEwRightsManagerX
Expand IEwSymbolCircuitXIEwSymbolCircuitX
Expand IEwSymbolFiltersXIEwSymbolFiltersX
Expand IEwSymbolManagerXIEwSymbolManagerX
Expand IEwSymbolPointXIEwSymbolPointX
Expand IEwSymbolXIEwSymbolX
Expand IEwTitleBlockManagerXIEwTitleBlockManagerX
Expand IEwTitleBlockXIEwTitleBlockX
Expand IEwXLSBookXIEwXLSBookX
Expand IEwXLSSheetXIEwXLSSheetX
Class Index
Expand Class HierarchyClass Hierarchy
Expand Class MembersClass Members
Expand SOLIDWORKS PDM Professional API HelpSOLIDWORKS PDM Professional API Help
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 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
Hide Table of Contents
SOLIDWORKS Electrical API  2020.0.5
Electrical API
Public Member Functions | List of all members
IEwCableReferenceX Interface Reference

Use this interface to manage cable reference. More...

Inheritance diagram for IEwCableReferenceX:
[legend]

Public Member Functions

IEwCableCoreX addEwCableCore (EwErrorCode *errorCode)
 Create and add a cable core for this cable reference. More...
 
EwErrorCode deleteCableCoreAt (LONG index)
 Delete a cable core from this cable reference. More...
 
LONG getCableCoreCount ()
 Count the number of cable core in this cable reference. More...
 
IEwCableCoreX getEwCableCoreAt (LONG index, EwErrorCode *errorCode)
 Get a cable core inside this cable reference. More...
 
BSTR getDescription (BSTR lgCode, EwErrorCode *errorCode)
 Get a description of this cable reference. More...
 
EwErrorCode setDescription (BSTR lgCode, BSTR strValue)
 Set a description of this cable reference. More...
 
BSTR getReference (EwErrorCode *errorCode)
 Get a reference of this cable reference. More...
 
EwErrorCode setReference (BSTR strReference)
 Set a reference of this cable reference. More...
 
BSTR getManufacturer (EwErrorCode *errorCode)
 Get a manufacturer of this cable reference. More...
 
EwErrorCode setManufacturer (BSTR strManufacturer)
 Set a manufacturer of this cable reference. More...
 
BSTR getArticleNumber (EwErrorCode *errorCode)
 Get an article number of this cable reference. More...
 
EwErrorCode setArticleNumber (BSTR strArticleNumber)
 Set an article number of this cable reference. More...
 
LONG getClassNodeID (EwErrorCode *errorCode)
 Get the classification node ID of this cable reference. More...
 
EwErrorCode setClassNodeID (LONG lNodeId)
 Set the classification node ID of this cable reference. More...
 
BSTR getLibraryCode (EwErrorCode *errorCode)
 Get a library code of this cable reference. More...
 
EwErrorCode setLibraryCode (BSTR strLibraryCode)
 Set a library code of this cable reference. More...
 
BSTR getFamily (EwErrorCode *errorCode)
 Get a family of this cable reference. More...
 
EwErrorCode setFamily (BSTR strFamily)
 Set a library of this cable reference. More...
 
BSTR getStandard (EwErrorCode *errorCode)
 Get a standard of this cable reference. More...
 
EwErrorCode setStandard (BSTR strStandard)
 Set a standard of this cable reference. More...
 
BSTR getSerie (EwErrorCode *errorCode)
 Get a serie of this cable reference. More...
 
BSTR getSupplierName (EwErrorCode *errorCode)
 Get a supplier name of this cable reference. More...
 
EwErrorCode setSupplierName (BSTR strSupplierName)
 Set a supplier name of this cable reference. More...
 
BSTR getStockNumber (EwErrorCode *errorCode)
 Get a stock number of this cable reference. More...
 
EwErrorCode setStockNumber (BSTR strStockNumber)
 Set a stock number of this cable reference. More...
 
DATE getModificationDate (EwErrorCode *errorCode)
 Get the last modification date of this cable reference. More...
 
DATE getCreationDate (EwErrorCode *errorCode)
 Get the creation date of this cable reference. More...
 
EwCreatorType getCreator (EwErrorCode *errorCode)
 Get the creator of this cable reference. More...
 
EwCableReferenceType getCableType (EwErrorCode *errorCode)
 Get a cable type of this cable reference. More...
 
EwErrorCode setCableType (EwCableReferenceType cableReferenceType)
 Set a cable type of this cable reference. More...
 
EwWireSizeStandard getWireSizeStandard (EwErrorCode *errorCode)
 Get the size standard of this cable reference. More...
 
EwErrorCode setWireSizeStandard (EwWireSizeStandard cableReferenceSizeStandard)
 Set the size standard of this cable reference. More...
 
DOUBLE getSection (EwErrorCode *errorCode)
 Get the section of this cable reference. More...
 
EwErrorCode setSection (DOUBLE dSection)
 Set the section of this cable reference. More...
 
DOUBLE getDiameter (EwErrorCode *errorCode)
 Get the diameter of this cable reference. More...
 
EwErrorCode setDiameter (DOUBLE dDiameter)
 Set the diameter of this cable reference. More...
 
BSTR getColorCode (EwErrorCode *errorCode)
 Get the color code of this cable reference. More...
 
EwErrorCode setColorCode (BSTR strColorCode)
 Set the color code of this cable reference. More...
 
DOUBLE getBendRadius (EwErrorCode *errorCode)
 Get the bend radius of this cable reference. More...
 
EwErrorCode setBendRadius (DOUBLE dBendRadius)
 Set the bend radius of this cable reference. More...
 
DOUBLE getVoltageDrop (EwErrorCode *errorCode)
 Get the voltage drop of this cable reference. More...
 
EwErrorCode setVoltageDrop (DOUBLE dVoltageDrop)
 Set the voltage drop of this cable reference. More...
 
EwErrorCode insert ()
 Insert this object inside the current environment. More...
 
EwErrorCode update ()
 Update this object inside the current environment. More...
 
EwErrorCode remove ()
 Remove this object inside the current environment. More...
 
BSTR getGauge (EwErrorCode *errorCode)
 Get the Gauge of this cable reference. More...
 
EwErrorCode setGauge (BSTR strGauge)
 Set the gauge of this cable reference. More...
 
BSTR getExternalID (EwErrorCode *errorCode)
 Get external identifier of this cable reference. More...
 
EwErrorCode setExternalID (BSTR strExternalID)
 Set the external identifier of this cable reference. More...
 
BSTR getModifiedBy (EwErrorCode *eErrorCode)
 Get the last user name that modified the current object. 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...
 

Detailed Description

Use this interface to manage cable reference.

Since
2018 SP0

Member Function Documentation

◆ addEwCableCore()

IEwCableCoreX IEwCableReferenceX::addEwCableCore ( EwErrorCode *  errorCode)

Create and add a cable core for this cable reference.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if an error occurred
Returns
The cable core and added

◆ deleteCableCoreAt()

EwErrorCode IEwCableReferenceX::deleteCableCoreAt ( LONG  index)

Delete a cable core from this cable reference.

Parameters
[in]indexThe index of cable core you want to delete
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if an error occurred
  • EW_BAD_INPUTS if index is not valid

◆ getArticleNumber()

BSTR IEwCableReferenceX::getArticleNumber ( EwErrorCode *  errorCode)

Get an article number of this cable reference.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if an error occurred
Returns
Will contains the article number in this cable reference

◆ getBendRadius()

DOUBLE IEwCableReferenceX::getBendRadius ( EwErrorCode *  errorCode)

Get the bend radius of this cable reference.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if an error occurred
Returns
Will contains the bend radius of this cable reference

◆ getCableCoreCount()

LONG IEwCableReferenceX::getCableCoreCount ( )

Count the number of cable core in this cable reference.

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

◆ getCableType()

EwCableReferenceType IEwCableReferenceX::getCableType ( EwErrorCode *  errorCode)

Get a cable type of this cable reference.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if an error occurred
Returns
Will contains the cable type of this cable reference

◆ getClassNodeID()

LONG IEwCableReferenceX::getClassNodeID ( EwErrorCode *  errorCode)

Get the classification node ID of this cable reference.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if an error occurred
Returns
Will contains the classification node ID

◆ getColorCode()

BSTR IEwCableReferenceX::getColorCode ( EwErrorCode *  errorCode)

Get the color code of this cable reference.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if an error occurred
Returns
Will contains the color code of this cable reference

◆ getCreationDate()

DATE IEwCableReferenceX::getCreationDate ( EwErrorCode *  errorCode)

Get the creation date of this cable reference.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if an error occurred
Returns
Will contains the creation date

◆ getCreator()

EwCreatorType IEwCableReferenceX::getCreator ( EwErrorCode *  errorCode)

Get the creator of this cable reference.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if an error occurred
Returns
Will contains the creator

◆ getDescription()

BSTR IEwCableReferenceX::getDescription ( BSTR  lgCode,
EwErrorCode *  errorCode 
)

Get a description of this cable reference.

Parameters
[in]lgCodeThe language of the description you want to get (like 'en' for english or 'fr' for french )
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if an error occurred
  • EW_BAD_INPUTS if lgCode is not valid
Returns
Will contains the description in this cable reference

◆ getDiameter()

DOUBLE IEwCableReferenceX::getDiameter ( EwErrorCode *  errorCode)

Get the diameter of this cable reference.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if an error occurred
Returns
Will contains the diameter (mm) of this cable reference

◆ getEwCableCoreAt()

IEwCableCoreX IEwCableReferenceX::getEwCableCoreAt ( LONG  index,
EwErrorCode *  errorCode 
)

Get a cable core inside this cable reference.

Parameters
[in]indexThe index of cable core you want to get
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if an error occurred
  • EW_BAD_INPUTS if index is not valid
Returns
The cable core

◆ getExternalID()

BSTR IEwCableReferenceX::getExternalID ( EwErrorCode *  errorCode)

Get external identifier of this cable reference.

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 contains the external identifier in this cable reference

◆ getFamily()

BSTR IEwCableReferenceX::getFamily ( EwErrorCode *  errorCode)

Get a family of this cable reference.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if an error occurred
Returns
Will contains the family in this cable reference

◆ getGauge()

BSTR IEwCableReferenceX::getGauge ( EwErrorCode *  errorCode)

Get the Gauge of this cable reference.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if an error occurred
  • EW_INVALID_CALL Impossible to call it, The standard isn't kCableReferenceSizeStandardGauge
Returns
Will contains the gauge of this cable reference

◆ getLibraryCode()

BSTR IEwCableReferenceX::getLibraryCode ( EwErrorCode *  errorCode)

Get a library code of this cable reference.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if an error occurred
Returns
Will contains the library code in this cable reference

◆ getLinearMass()

BSTR IEwCableReferenceX::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 an error occurred
Returns
a string with linear mass (density) of this cable

◆ getManufacturer()

BSTR IEwCableReferenceX::getManufacturer ( EwErrorCode *  errorCode)

Get a manufacturer of this cable reference.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if an error occurred
Returns
Will contains the reference in this cable reference

◆ getModificationDate()

DATE IEwCableReferenceX::getModificationDate ( EwErrorCode *  errorCode)

Get the last modification date of this cable reference.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if an error occurred
Returns
Will contains the last modification date

◆ getModifiedBy()

BSTR IEwCableReferenceX::getModifiedBy ( EwErrorCode *  eErrorCode)

Get the last user name that modified the current object.

Since
2020 SP0
Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if an error occurred
Returns
a string with the user name that modified the current object

◆ getReference()

BSTR IEwCableReferenceX::getReference ( EwErrorCode *  errorCode)

Get a reference of this cable reference.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if an error occurred
Returns
Will contains the reference in this cable reference

◆ getSection()

DOUBLE IEwCableReferenceX::getSection ( EwErrorCode *  errorCode)

Get the section of this cable reference.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if an error occurred
  • EW_INVALID_CALL Impossible to call it, The standard isn't kCableReferenceSizeStandardSection
Returns
Will contains the section of this cable reference

◆ getSerie()

BSTR IEwCableReferenceX::getSerie ( EwErrorCode *  errorCode)

Get a serie of this cable reference.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if an error occurred
Returns
Will contains the serie in this cable reference

◆ getStandard()

BSTR IEwCableReferenceX::getStandard ( EwErrorCode *  errorCode)

Get a standard of this cable reference.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if an error occurred
Returns
Will contains the standard in this cable reference

◆ getStockNumber()

BSTR IEwCableReferenceX::getStockNumber ( EwErrorCode *  errorCode)

Get a stock number of this cable reference.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if an error occurred
Returns
Will contains the stock number of this cable reference

◆ getSupplierName()

BSTR IEwCableReferenceX::getSupplierName ( EwErrorCode *  errorCode)

Get a supplier name of this cable reference.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if an error occurred
Returns
Will contains the supplier name of this cable reference

◆ getVoltageDrop()

DOUBLE IEwCableReferenceX::getVoltageDrop ( EwErrorCode *  errorCode)

Get the voltage drop of this cable reference.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if an error occurred
Returns
Will contains the voltage drop of this cable reference

◆ getWireSizeStandard()

EwWireSizeStandard IEwCableReferenceX::getWireSizeStandard ( EwErrorCode *  errorCode)

Get the size standard of this cable reference.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if an error occurred
Returns
Will contains the size standard of this cable reference

◆ insert()

EwErrorCode IEwCableReferenceX::insert ( )

Insert this object inside the current environment.

Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if an error occurred
  • EW_INSERTION_FAILED if the insertion failed
  • EW_BAD_INPUTS if reference or manufacturer is empty
  • EW_OBJECT_ALREADY_INSERTED if this object already exists

◆ remove()

EwErrorCode IEwCableReferenceX::remove ( )

Remove this object inside the current environment.

Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if an error occurred

◆ setArticleNumber()

EwErrorCode IEwCableReferenceX::setArticleNumber ( BSTR  strArticleNumber)

Set an article number of this cable reference.

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

◆ setBendRadius()

EwErrorCode IEwCableReferenceX::setBendRadius ( DOUBLE  dBendRadius)

Set the bend radius of this cable reference.

Parameters
[in]dBendRadiusThe bend radius you want to set
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if an error occurred
  • EW_BAD_INPUTS if dBendRadius is negative

◆ setCableType()

EwErrorCode IEwCableReferenceX::setCableType ( EwCableReferenceType  cableReferenceType)

Set a cable type of this cable reference.

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

◆ setClassNodeID()

EwErrorCode IEwCableReferenceX::setClassNodeID ( LONG  lNodeId)

Set the classification node ID of this cable reference.

Parameters
[in]lNodeIdThe classification node id you want to set
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if an error occurred

◆ setColorCode()

EwErrorCode IEwCableReferenceX::setColorCode ( BSTR  strColorCode)

Set the color code of this cable reference.

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 an error occurred

◆ setDescription()

EwErrorCode IEwCableReferenceX::setDescription ( BSTR  lgCode,
BSTR  strValue 
)

Set a description of this cable reference.

Parameters
[in]lgCodeThe language of the description you want to set (like 'en' for english or 'fr' for french )
[in]strValueThe description you want to set
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if an error occurred
  • EW_BAD_INPUTS if lgCode is not valid

◆ setDiameter()

EwErrorCode IEwCableReferenceX::setDiameter ( DOUBLE  dDiameter)

Set the diameter of this cable reference.

Parameters
[in]dDiameterThe diameter you want to set (mm)
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if an error occurred
  • EW_BAD_INPUTS if dDiameter is negative

◆ setExternalID()

EwErrorCode IEwCableReferenceX::setExternalID ( BSTR  strExternalID)

Set the external identifier of this cable reference.

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 an error occurred

◆ setFamily()

EwErrorCode IEwCableReferenceX::setFamily ( BSTR  strFamily)

Set a library of this cable reference.

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

◆ setGauge()

EwErrorCode IEwCableReferenceX::setGauge ( BSTR  strGauge)

Set the gauge of this cable reference.

Parameters
[in]strGaugeThe gauge you want to set
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if an error occurred
  • EW_INVALID_CALL Impossible to call it, The standard isn't kCableReferenceSizeStandardGauge

◆ setLibraryCode()

EwErrorCode IEwCableReferenceX::setLibraryCode ( BSTR  strLibraryCode)

Set a library code of this cable reference.

Parameters
[in]strLibraryCodeThe library code you want to set
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if an error occurred

◆ setLinearMass()

EwErrorCode IEwCableReferenceX::setLinearMass ( BSTR  strLinearMass)

Set the linear mass (density) of this cable.

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_BAD_INPUTS if the length of value is greater than maximum length of the field or units are not allowed
  • EW_UNDEFINED_ERROR if an error occurred

◆ setManufacturer()

EwErrorCode IEwCableReferenceX::setManufacturer ( BSTR  strManufacturer)

Set a manufacturer of this cable reference.

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

◆ setReference()

EwErrorCode IEwCableReferenceX::setReference ( BSTR  strReference)

Set a reference of this cable reference.

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

◆ setSection()

EwErrorCode IEwCableReferenceX::setSection ( DOUBLE  dSection)

Set the section of this cable reference.

Parameters
[in]dSectionThe section you want to set
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if an error occurred
  • EW_BAD_INPUTS if if dSection is negative
  • EW_INVALID_CALL Impossible to call it, The standard isn't kCableReferenceSizeStandardSection

◆ setStandard()

EwErrorCode IEwCableReferenceX::setStandard ( BSTR  strStandard)

Set a standard of this cable reference.

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

◆ setStockNumber()

EwErrorCode IEwCableReferenceX::setStockNumber ( BSTR  strStockNumber)

Set a stock number of this cable reference.

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

◆ setSupplierName()

EwErrorCode IEwCableReferenceX::setSupplierName ( BSTR  strSupplierName)

Set a supplier name of this cable reference.

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

◆ setVoltageDrop()

EwErrorCode IEwCableReferenceX::setVoltageDrop ( DOUBLE  dVoltageDrop)

Set the voltage drop of this cable reference.

Parameters
[in]dVoltageDropThe voltage drop you want to set
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if an error occurred
  • EW_BAD_INPUTS if dBendRadius is negative

◆ setWireSizeStandard()

EwErrorCode IEwCableReferenceX::setWireSizeStandard ( EwWireSizeStandard  cableReferenceSizeStandard)

Set the size standard of this cable reference.

Parameters
[in]cableReferenceSizeStandardThe size standard you want to set
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if an error occurred

◆ update()

EwErrorCode IEwCableReferenceX::update ( )

Update this object inside the current environment.

Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_DOES_NOT_EXIST_ERROR If object was not previously inserted
  • EW_UNDEFINED_ERROR if an error occurred
  • EW_NOT_IMPLEMENTED Not implemented.
Generated on Tue Sep 1 2020 17:01:23 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: IEwCableReferenceX 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) 2020 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