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
Expand Class ListClass List
Class Index
Collapse Class HierarchyClass Hierarchy
_DIEwProjectXEvents
Collapse IDispatchIDispatch
IEwAddIn
IEwAPIX
IEwApplicationReactorX
IEwApplicationSettingsX
IEwApplicationX
IEwArchiveEnvironmentX
IEwCableCoreX
IEwCableReferenceManagerX
IEwCableReferenceX
IEwCommandContextX
IEwCommandManagerX
IEwCommandX
IEwDialogAlignPartsParametersSelectorX
IEwDialogLocationSelectorX
IEwDialogMacroSelectorX
IEwDialogManufacturerPartOrderingX
IEwDialogManufacturerPartSelectorX
IEwDialogProgressX
IEwDialogProjectManagerX
IEwDialogResumeX
IEwDialogSummaryX
IEwDialogTaskX
IEwEnvironmentX
IEwInteropFactoryX
IEwLibraryManagerX
IEwLibraryX
IEwLockStringX
IEwManufacturerPartCircuitX
IEwManufacturerPartManagerX
IEwManufacturerPartTerminalX
IEwManufacturerPartX
Expand IEwObjectBaseXIEwObjectBaseX
IEwPointX
IEwProjectAutomaticArrowsX
IEwProjectBookManagerX
IEwProjectCableManagerX
IEwProjectComponentCircuitX
IEwProjectComponentManagerX
IEwProjectComponentTerminalX
IEwProjectEntity3DManagerX
IEwProjectExportDWGFilesX
IEwProjectExportPDMX
IEwProjectExportReportX
IEwProjectFileManagerX
IEwProjectFolderManagerX
IEwProjectFunctionManagerX
IEwProjectGenerateTSDrawingX
IEwProjectHarnessManagerX
IEwProjectLocationManagerX
IEwProjectManagerX
IEwProjectManufacturerPartCircuitX
IEwProjectManufacturerPartManagerX
IEwProjectManufacturerPartTerminalX
IEwProjectManufacturerPartX
IEwProjectNumberDocumentsX
IEwProjectNumberMarksX
IEwProjectNumberWiresX
IEwProjectOptimizeWireOrderX
IEwProjectPrintConfigManagerX
IEwProjectReportManagerX
IEwProjectSnapshotManagerX
IEwProjectSnapshotX
IEwProjectSymbolManagerX
IEwProjectUpdateReplaceDataX
IEwProjectWireManagerX
IEwProjectX
IEwResumeRowX
IEwRibbonControlX
IEwRibbonGroupX
IEwRibbonTabX
IEwRibbonX
IEwRightsManagerX
IEwSymbolCircuitX
IEwSymbolFiltersX
IEwSymbolManagerX
IEwSymbolPointX
IEwSymbolX
IEwTitleBlockManagerX
IEwTitleBlockX
IEwXLSBookX
IEwXLSSheetX
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
IEwCableCoreX Interface Reference

Use this interface to manage a cable core inside a cable reference. More...

Inheritance diagram for IEwCableCoreX:
[legend]

Public Member Functions

LONG getNumber ()
 Get the number of this cable core. More...
 
BSTR getDescription (BSTR lgCode, EwErrorCode *errorCode)
 Get a description of this cable core. More...
 
EwErrorCode setDescription (BSTR lgCode, BSTR strValue)
 Set a description of this cable core. More...
 
EwCableCoreType getEwCableCoreType (EwErrorCode *errorCode)
 Get the type of cable core. More...
 
EwErrorCode setEwCableCoreType (EwCableCoreType cableCoreType)
 Set the type of cable core. More...
 
DOUBLE getSection (EwErrorCode *errorCode)
 Get the section of this cable core. More...
 
EwErrorCode setSection (DOUBLE dSection)
 Set the section of this cable core. More...
 
BSTR getGroup (EwErrorCode *errorCode)
 Get the group of this cable core. More...
 
EwErrorCode setGroup (BSTR strGroup)
 Set the group of this cable core. More...
 
BSTR getGauge (EwErrorCode *errorCode)
 Get the gauge of this cable core. More...
 
EwErrorCode setGauge (BSTR strGauge)
 Set the gauge of this cable core. More...
 
BSTR getColorCode (EwErrorCode *errorCode)
 Get the color code of this cable core. More...
 
EwErrorCode setColorCode (BSTR strColorCode)
 Set the color code of this cable core. More...
 

Detailed Description

Use this interface to manage a cable core inside a cable reference.

Since
2018 SP0

Member Function Documentation

◆ getColorCode()

BSTR IEwCableCoreX::getColorCode ( EwErrorCode *  errorCode)

Get the color code of this cable core.

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

◆ getDescription()

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

Get a description of this cable core.

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 core

◆ getEwCableCoreType()

EwCableCoreType IEwCableCoreX::getEwCableCoreType ( EwErrorCode *  errorCode)

Get the type of cable core.

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 type of cable core

◆ getGauge()

BSTR IEwCableCoreX::getGauge ( EwErrorCode *  errorCode)

Get the gauge of this cable core.

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 gauge

◆ getGroup()

BSTR IEwCableCoreX::getGroup ( EwErrorCode *  errorCode)

Get the group of this cable core.

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 group

◆ getNumber()

LONG IEwCableCoreX::getNumber ( )

Get the number of this cable core.

Returns
The cable core number or -1 if an error occurred

◆ getSection()

DOUBLE IEwCableCoreX::getSection ( EwErrorCode *  errorCode)

Get the section of this cable core.

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 section

◆ setColorCode()

EwErrorCode IEwCableCoreX::setColorCode ( BSTR  strColorCode)

Set the color code of this cable core.

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 IEwCableCoreX::setDescription ( BSTR  lgCode,
BSTR  strValue 
)

Set a description of this cable core.

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

◆ setEwCableCoreType()

EwErrorCode IEwCableCoreX::setEwCableCoreType ( EwCableCoreType  cableCoreType)

Set the type of cable core.

Parameters
[in]cableCoreTypeThe type of cable core 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 IEwCableCoreX::setGauge ( BSTR  strGauge)

Set the gauge of this cable core.

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

◆ setGroup()

EwErrorCode IEwCableCoreX::setGroup ( BSTR  strGroup)

Set the group of this cable core.

Parameters
[in]strGroupThe group 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 IEwCableCoreX::setSection ( DOUBLE  dSection)

Set the section of this cable core.

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 dSection is negative
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: IEwCableCoreX 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.21