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
Expand IEwProjectTagObjectXIEwProjectTagObjectX
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
IEwProjectWireStyleX Interface Reference

Use this interface to manage Wire Style inside a project. More...

Inheritance diagram for IEwProjectWireStyleX:
Inheritance graph

Public Member Functions

BSTR getName (EwErrorCode *errorCode)
 Get the name of the current object. More...
 
EwErrorCode setName (BSTR strName)
 Set the name of the current object. More...
 
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 setDispSchema (BSTR strDispSchema)
 Set the disp schema of the current object. More...
 
BSTR getDispSchema (EwErrorCode *errorCode)
 Get the disp schema of the current object. More...
 
BSTR getTension (EwErrorCode *errorCode)
 Get the tension of the current object. More...
 
EwErrorCode setTension (BSTR strTension)
 Set the tension of the current object. More...
 
BSTR getFrequence (EwErrorCode *errorCode)
 Get the frequence of the current object. More...
 
EwErrorCode setFrequence (BSTR strFrequence)
 Set the frequence of the current object. More...
 
BSTR getWireSectionGauge (EwErrorCode *errorCode)
 Get the wire section gauge of the current object. More...
 
EwErrorCode setWireSectionGauge (BSTR strWireSectionGauge)
 Set the wire section gauge of the current object. More...
 
BSTR getEquipTagFormula (EwErrorCode *errorCode)
 Get the equip tag formula of the current object. More...
 
EwErrorCode setEquipTagFormula (BSTR strEquipTagFormula)
 Set the equip tag formula of the current object. More...
 
BSTR getWireTagFormula (EwErrorCode *errorCode)
 Get the wire tag formula of the current object. More...
 
EwErrorCode setWireTagFormula (BSTR strWireTagFormula)
 Set the wire tag formula of the current object. More...
 
LONG getNumberID (EwErrorCode *errorCode)
 Get the number ID of the current object. More...
 
EwErrorCode setNumberID (LONG lNumberID)
 Set the number ID of the current object. 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 getWireColorName (EwErrorCode *errorCode)
 Get the wire color name of the current object. More...
 
EwErrorCode setWireColorName (BSTR strWireColorName)
 Set the wire color name of the current object. More...
 
BSTR getDispTerminal (EwErrorCode *errorCode)
 Get the disp terminal of the current object. More...
 
EwErrorCode setDispTerminal (BSTR strDispTerminal)
 Set the disp terminal of the current object. More...
 
BSTR getDispWiring (EwErrorCode *errorCode)
 Get the disp wiring of the current object. More...
 
EwErrorCode setDispWiring (BSTR strDispWiring)
 Set the disp wiring of the current object. More...
 
LONG getOrderNo (EwErrorCode *errorCode)
 Get the order no of the current object. More...
 
EwErrorCode setOrderNo (LONG lOrderNo)
 Set the order no of the current object. More...
 
EwErrorCode setEwPhaseType (EwPhaseType ePhaseType)
 Set the frequence of the current object. More...
 
EwPhaseType getEwPhaseType (EwErrorCode *errorCode)
 Get the EwPhaseType of the current object. More...
 
EwErrorCode setLineWidth (double dLineWidth)
 Set the line width of the current object. More...
 
double getLineWidth (EwErrorCode *errorCode)
 Get the line width of the current object. More...
 
EwErrorCode setPropagate (VARIANT_BOOL bPropagate)
 Set the propagate value of the current object. More...
 
VARIANT_BOOL getPropagate (EwErrorCode *errorCode)
 Get the propagate value of the current object. More...
 
EwErrorCode setColor (long lColor)
 Set the color of the current object. More...
 
long getColor (EwErrorCode *errorCode)
 Get the color of the current object. More...
 
EwErrorCode setCableDiameter (double dDiameter)
 Set the cable diameter of the current object. More...
 
double getCableDiameter (EwErrorCode *errorCode)
 Get the cable diameter of the current object. More...
 
EwErrorCode setWireSizeStandard (EwWireSizeStandard eWireSizeStandard)
 Set the wire size standard of the current object. More...
 
EwWireSizeStandard getWireSizeStandard (EwErrorCode *errorCode)
 Get the wire size standard of the current object. More...
 
EwErrorCode setEwProjectCableXByID (long lEwProjectCableID)
 Set EwProjectCableX by ID in the current object. More...
 
long getEwProjectCableXByID (EwErrorCode *errorCode)
 Get the ID of EwProjectCableX in the current object. More...
 
IEwProjectCableX getEwProjectCableX (EwErrorCode *errorCode)
 Get the EwProjectCableX of the current 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...
 
- 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 Style inside a project.

Since
2024 SP0

Member Function Documentation

◆ getBendRadius()

DOUBLE IEwProjectWireStyleX::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.

◆ getCableDiameter()

double IEwProjectWireStyleX::getCableDiameter ( EwErrorCode *  errorCode)

Get the cable diameter of 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
cable diameterof wire style

◆ getColor()

long IEwProjectWireStyleX::getColor ( EwErrorCode *  errorCode)

Get the color of 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
color of wire style

◆ getDispSchema()

BSTR IEwProjectWireStyleX::getDispSchema ( EwErrorCode *  errorCode)

Get the disp schema of 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
disp schema of wire style

◆ getDispTerminal()

BSTR IEwProjectWireStyleX::getDispTerminal ( EwErrorCode *  errorCode)

Get the disp terminal of 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
will contain the name

◆ getDispWiring()

BSTR IEwProjectWireStyleX::getDispWiring ( EwErrorCode *  errorCode)

Get the disp wiring of 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
disp wiring of wire style

◆ getEquipTagFormula()

BSTR IEwProjectWireStyleX::getEquipTagFormula ( EwErrorCode *  errorCode)

Get the equip tag formula of 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
equip tag formula of wire style

◆ getEwPhaseType()

EwPhaseType IEwProjectWireStyleX::getEwPhaseType ( EwErrorCode *  errorCode)

Get the EwPhaseType of 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
EwPhaseType enum type, can be :
  • kPhaseTypeUnKnown Phase type : Unknown
  • kPhase1 Phase type : Phase 1
  • kPhase2 Phase type : Phase 2
  • kPhase3 Phase type : Phase 3
  • kNeutre Phase type : Neutral
  • kProtection Phase type : Protection - Earth - Ground
  • kCommande Phase type : Control wire
  • kSynoptic Phase type : Line diagram

◆ getEwProjectCableX()

IEwProjectCableX IEwProjectWireStyleX::getEwProjectCableX ( EwErrorCode *  errorCode)

Get the EwProjectCableX of 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
EwProjectCableX of current object

◆ getEwProjectCableXByID()

long IEwProjectWireStyleX::getEwProjectCableXByID ( EwErrorCode *  errorCode)

Get the ID of EwProjectCableX in 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
ID of EwProjectCableX associate to wire style

◆ getFrequence()

BSTR IEwProjectWireStyleX::getFrequence ( EwErrorCode *  errorCode)

Get the frequence of 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
frequence of wire tyle

◆ getLinearMass()

BSTR IEwProjectWireStyleX::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

◆ getLineWidth()

double IEwProjectWireStyleX::getLineWidth ( EwErrorCode *  errorCode)

Get the line width of 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
line width of wire style

◆ getName()

BSTR IEwProjectWireStyleX::getName ( EwErrorCode *  errorCode)

Get the name of 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
name of wire style

◆ getNumberID()

LONG IEwProjectWireStyleX::getNumberID ( EwErrorCode *  errorCode)

Get the number ID of 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
number ID of wire style

◆ getOrderNo()

LONG IEwProjectWireStyleX::getOrderNo ( EwErrorCode *  errorCode)

Get the order no of 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
will contain the name

◆ getPropagate()

VARIANT_BOOL IEwProjectWireStyleX::getPropagate ( EwErrorCode *  errorCode)

Get the propagate value of the current object.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_INVALID_OBJECT if object is not initialized
  • EW_UNDEFINED_ERROR if another error occurred
Returns
true is propagete, otherwise false

◆ getTension()

BSTR IEwProjectWireStyleX::getTension ( EwErrorCode *  errorCode)

Get the tension of 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
tension of wire style

◆ getTranslatedData()

BSTR IEwProjectWireStyleX::getTranslatedData ( LONG  nUserDataNumber,
BSTR  strLanguage,
EwErrorCode *  errorCode 
)

Get the value of a translated text.

Parameters
[in]nUserDataNumberNumber of the text to get
[in]strLanguageLanguage code of the text to get
[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_BAD_INPUTS if the language code is not supported
  • EW_NO_ERROR No error detected
Returns
Value of the text to get

◆ getWireColorName()

BSTR IEwProjectWireStyleX::getWireColorName ( EwErrorCode *  errorCode)

Get the wire color name of 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
wire color name of wire style

◆ getWireSectionGauge()

BSTR IEwProjectWireStyleX::getWireSectionGauge ( EwErrorCode *  errorCode)

Get the wire section gauge of 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
wire section gauge of wire style

◆ getWireSizeStandard()

EwWireSizeStandard IEwProjectWireStyleX::getWireSizeStandard ( EwErrorCode *  errorCode)

Get the wire size standard of 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
EwWireSizeStandard enum type, can be :
  • kUnknowWireSizeStd For undefined size standard default value
  • kWireSizeSection For size in section (mm2)
  • kWireSizeGauge For size in American Wire Gauge (AWG)
  • kWireSizeKcmil For size in KCMIL (1000 circular mils)

◆ getWireTagFormula()

BSTR IEwProjectWireStyleX::getWireTagFormula ( EwErrorCode *  errorCode)

Get the wire tag formula of 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
wire tag formula of wire style

◆ setBendRadius()

EwErrorCode IEwProjectWireStyleX::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

◆ setCableDiameter()

EwErrorCode IEwProjectWireStyleX::setCableDiameter ( double  dDiameter)

Set the cable diameter of the current object.

Parameters
[in]dDiameternew diameter you want to set
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 new diameter is negative
  • EW_BAD_INPUTS if the dDiameter is invalid (dDiameter < 0)
  • EW_NO_ERROR if no error detected

◆ setColor()

EwErrorCode IEwProjectWireStyleX::setColor ( long  lColor)

Set the color of the current object.

Parameters
[in]lColornew color you want to set
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 lColor is negative
  • EW_NO_ERROR if no error detected

◆ setDispSchema()

EwErrorCode IEwProjectWireStyleX::setDispSchema ( BSTR  strDispSchema)

Set the disp schema of the current object.

Parameters
[in]strDispSchemanew disp schema you want to set
Returns
EwErrorCode 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

◆ setDispTerminal()

EwErrorCode IEwProjectWireStyleX::setDispTerminal ( BSTR  strDispTerminal)

Set the disp terminal of the current object.

Parameters
[in]strDispTerminalnew disp terminal you want to set
Returns
EwErrorCode 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

◆ setDispWiring()

EwErrorCode IEwProjectWireStyleX::setDispWiring ( BSTR  strDispWiring)

Set the disp wiring of the current object.

Parameters
[in]strDispWiringnew disp wiring you want to set
Returns
EwErrorCode 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

◆ setEquipTagFormula()

EwErrorCode IEwProjectWireStyleX::setEquipTagFormula ( BSTR  strEquipTagFormula)

Set the equip tag formula of the current object.

Parameters
[in]strEquipTagFormulanew the equip tag formula you want to set
Returns
EwErrorCode 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

◆ setEwPhaseType()

EwErrorCode IEwProjectWireStyleX::setEwPhaseType ( EwPhaseType  ePhaseType)

Set the frequence of the current object.

Parameters
[in]ePhaseTypeenum type, can be :
  • kPhaseTypeUnKnown Phase type : Unknown
  • kPhase1 Phase type : Phase 1
  • kPhase2 Phase type : Phase 2
  • kPhase3 Phase type : Phase 3
  • kNeutre Phase type : Neutral
  • kProtection Phase type : Protection - Earth - Ground
  • kCommande Phase type : Control wire
  • kSynoptic Phase type : Line diagram
Returns
EwErrorCode 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

◆ setEwProjectCableXByID()

EwErrorCode IEwProjectWireStyleX::setEwProjectCableXByID ( long  lEwProjectCableID)

Set EwProjectCableX by ID in the current object.

Parameters
[in]lEwProjectCableIDid of EwProjectCableX you want to set
Returns
EwErrorCode 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

◆ setFrequence()

EwErrorCode IEwProjectWireStyleX::setFrequence ( BSTR  strFrequence)

Set the frequence of the current object.

Parameters
[in]strFrequencenew frequence you want to set
Returns
EwErrorCode 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

◆ setLinearMass()

EwErrorCode IEwProjectWireStyleX::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

◆ setLineWidth()

EwErrorCode IEwProjectWireStyleX::setLineWidth ( double  dLineWidth)

Set the line width of the current object.

Parameters
[in]dLineWidthnew line width you want to set
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 dLineWidth is invalid (dLineWidth < 0)
  • EW_NO_ERROR if no error detected

◆ setName()

EwErrorCode IEwProjectWireStyleX::setName ( BSTR  strName)

Set the name of the current object.

Parameters
[in]strNameThe name you want to set
Returns
EwErrorCode 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

◆ setNumberID()

EwErrorCode IEwProjectWireStyleX::setNumberID ( LONG  lNumberID)

Set the number ID of the current object.

Parameters
[in]lNumberIDnew number ID you want to set
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 lNumberID is invalid (dLineWidth < 0)
  • EW_NO_ERROR if no error detected

◆ setOrderNo()

EwErrorCode IEwProjectWireStyleX::setOrderNo ( LONG  lOrderNo)

Set the order no of the current object.

Parameters
[in]lOrderNonez order no you want to set
Returns
EwErrorCode 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

◆ setPropagate()

EwErrorCode IEwProjectWireStyleX::setPropagate ( VARIANT_BOOL  bPropagate)

Set the propagate value of the current object.

Parameters
[in]bPropagatenew propagate value you want to set
Returns
EwErrorCode 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

◆ setTension()

EwErrorCode IEwProjectWireStyleX::setTension ( BSTR  strTension)

Set the tension of the current object.

Parameters
[in]strTensionnew tension you want to set
Returns
EwErrorCode 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

◆ setTranslatedData()

EwErrorCode IEwProjectWireStyleX::setTranslatedData ( LONG  nUserDataNumber,
BSTR  strLanguage,
BSTR  strValue 
)

Set the value of a translated text.

Parameters
[in]nUserDataNumberNumber of the text to set
[in]strLanguageLanguage of the text
[in]strValueValue of the text
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_BAD_INPUTS if the language code is not supported
  • EW_NO_ERROR No error detected

◆ setWireColorName()

EwErrorCode IEwProjectWireStyleX::setWireColorName ( BSTR  strWireColorName)

Set the wire color name of the current object.

Parameters
[in]strWireColorNamenew wire color name you want to set
Returns
EwErrorCode 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

◆ setWireSectionGauge()

EwErrorCode IEwProjectWireStyleX::setWireSectionGauge ( BSTR  strWireSectionGauge)

Set the wire section gauge of the current object.

Parameters
[in]strWireSectionGaugenew wire section gauge you want to set
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 empty
  • EW_NO_ERROR if no error detected

◆ setWireSizeStandard()

EwErrorCode IEwProjectWireStyleX::setWireSizeStandard ( EwWireSizeStandard  eWireSizeStandard)

Set the wire size standard of the current object.

Parameters
[in]eWireSizeStandardenum type, can be :
  • kUnknowWireSizeStd For undefined size standard default value
  • kWireSizeSection For size in section (mm2)
  • kWireSizeGauge For size in American Wire Gauge (AWG)
  • kWireSizeKcmil For size in KCMIL (1000 circular mils)
Returns
EwErrorCode 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

◆ setWireTagFormula()

EwErrorCode IEwProjectWireStyleX::setWireTagFormula ( BSTR  strWireTagFormula)

Set the wire tag formula of the current object.

Parameters
[in]strWireTagFormulanew wire tag formula you want to set
Returns
EwErrorCode 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
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: IEwProjectWireStyleX 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.

10.20.4