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
IEwEXCELImportLibraryX
IEwEnvironmentX
IEwLibraryManagerX
IEwLockStringX
IEwManagerDialogX
IEwManufacturerPartCircuitX
IEwManufacturerPartManagerX
IEwManufacturerPartTerminalX
IEwMenuItemX
IEwMenuManagerX
IEwMenuX
IEwNotificationDialogX
Collapse IEwObjectDispatchXIEwObjectDispatchX
IEwPointX
IEwProjectAutomaticArrowsX
IEwProjectBookManagerX
IEwProjectCableManagerX
IEwProjectComponentManagerX
IEwProjectEntity3DManagerX
IEwProjectExcelAutomationX
IEwProjectExportDWGFilesX
IEwProjectExportPDFX
IEwProjectExportPDMX
IEwProjectExportReportX
IEwProjectFileConfigurationManagerX
IEwProjectFileConfigurationX
IEwProjectFileManagerX
IEwProjectFolderManagerX
IEwProjectFunctionManagerX
IEwProjectGenerateTSDrawingX
IEwProjectHarnessManagerX
IEwProjectInputOutputManagerX
IEwProjectLineManagerX
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 SOLIDWORKS Visualize API HelpSOLIDWORKS Visualize 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 2025.0.0
Electrical API
Public Member Functions | List of all members
IEwProjectWireStyleBase Interface Reference

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

Inheritance diagram for IEwProjectWireStyleBase:

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 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...
 
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 setColor (long lColor)
 Set the color of the current object. More...
 
long getColor (EwErrorCode *errorCode)
 Get the color 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...
 
BSTR getDescription (BSTR strLanguage, EwErrorCode *errorCode)
 Get the description associated to the object. More...
 
EwErrorCode setDescription (BSTR strLanguage, BSTR strDescription)
 Set the description associated to the 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 Wire Style inside a project.

Since
2025 SP01

Member Function Documentation

◆ getColor()

long IEwProjectWireStyleBase::getColor ( EwErrorCode *  errorCode)

Get the color of the current object.

Since
2025 SP01
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

◆ getDescription()

BSTR IEwProjectWireStyleBase::getDescription ( BSTR  strLanguage,
EwErrorCode *  errorCode 
)

Get the description associated to the object.

Since
2025 SP1.
Parameters
[in]strLanguageThe language of the description you want to get (like 'en' for english or 'fr' for french )
[out]errorCodeEwErrorCode enum, can be:
  • EW_UNDEFINED_ERROR if another error occurred.
  • EW_INVALID_OBJECT if object base is not initialized.
  • EW_INVALID_OBJECT if current object is not inserted.
  • EW_PROJECT_NOTOPENED if project not opened.
  • EW_BAD_INPUTS if the given language is not found.
  • EW_NO_ERROR if no error detected.

◆ getEwProjectCableX()

IEwProjectCableX IEwProjectWireStyleBase::getEwProjectCableX ( EwErrorCode *  errorCode)

Get the EwProjectCableX of the current object.

Since
2025 SP01
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 IEwProjectWireStyleBase::getEwProjectCableXByID ( EwErrorCode *  errorCode)

Get the ID of EwProjectCableX in the current object.

Since
2025 SP01
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

◆ getLineWidth()

double IEwProjectWireStyleBase::getLineWidth ( EwErrorCode *  errorCode)

Get the line width of the current object.

Since
2025 SP01
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 IEwProjectWireStyleBase::getName ( EwErrorCode *  errorCode)

Get the name of the current object.

Since
2025 SP01
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

◆ getTranslatedData()

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

Get the value of a translated text.

Since
2025 SP01
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 IEwProjectWireStyleBase::getWireColorName ( EwErrorCode *  errorCode)

Get the wire color name of the current object.

Since
2025 SP01
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

◆ setColor()

EwErrorCode IEwProjectWireStyleBase::setColor ( long  lColor)

Set the color of the current object.

Since
2025 SP01
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

◆ setDescription()

EwErrorCode IEwProjectWireStyleBase::setDescription ( BSTR  strLanguage,
BSTR  strDescription 
)

Set the description associated to the object.

Since
2025 SP1.
Parameters
[in]strLanguageThe language of the description you want to get (like 'en' for english or 'fr' for french )
[in]strDescriptionThe description to add
Returns
errorCode EwErrorCode enum, can be:
  • EW_UNDEFINED_ERROR if another error occurred.
  • EW_INVALID_OBJECT if object base is not initialized.
  • EW_INVALID_OBJECT if current object is not inserted.
  • EW_PROJECT_NOTOPENED if project not opened.
  • EW_BAD_INPUTS if the given language is not found.
  • EW_BAD_INPUTS if the given description is empty.
  • EW_NO_ERROR if no error detected.

◆ setEwProjectCableXByID()

EwErrorCode IEwProjectWireStyleBase::setEwProjectCableXByID ( long  lEwProjectCableID)

Set EwProjectCableX by ID in the current object.

Since
2025 SP01
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

◆ setLineWidth()

EwErrorCode IEwProjectWireStyleBase::setLineWidth ( double  dLineWidth)

Set the line width of the current object.

Since
2025 SP01
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 IEwProjectWireStyleBase::setName ( BSTR  strName)

Set the name of the current object.

Since
2025 SP01
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_BAD_INPUTS if only (" ") character fill the name or empty
  • EW_NO_ERROR if no error detected

◆ setTranslatedData()

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

Set the value of a translated text.

Since
2025 SP01
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 or number is not valid
  • EW_NO_ERROR No error detected

◆ setWireColorName()

EwErrorCode IEwProjectWireStyleBase::setWireColorName ( BSTR  strWireColorName)

Set the wire color name of the current object.

Since
2025 SP01
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
Generated 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: IEwProjectWireStyleBase 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) 2025 SP2

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