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 C# SamplesC# Samples
Expand List of SWE commandsList of SWE commands
Collapse ClassesClasses
Collapse Class ListClass List
Expand IEwAddInIEwAddIn
IEwAddinInternalX
Expand IEwAPIXIEwAPIX
Expand IEwApplicationSettingsXIEwApplicationSettingsX
Expand IEwApplicationXIEwApplicationX
Expand IEwArchiveEnvironmentXIEwArchiveEnvironmentX
Expand IEwCableCoreXIEwCableCoreX
Expand IEwCableReferenceManagerXIEwCableReferenceManagerX
Expand IEwCableReferenceXIEwCableReferenceX
Expand IEwCaptionBarControlXIEwCaptionBarControlX
Expand IEwCaptionBarXIEwCaptionBarX
Expand IEwClassificationManagerXIEwClassificationManagerX
Expand IEwClassificationXIEwClassificationX
Collapse IEwClassXIEwClassX
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 IEwDockingPaneManagerXIEwDockingPaneManagerX
Expand IEwDockingPaneXIEwDockingPaneX
Expand IEwDocumentManagerXIEwDocumentManagerX
Expand IEwDocumentXIEwDocumentX
Expand IEwEnvironmentObjectXIEwEnvironmentObjectX
Expand IEwEnvironmentXIEwEnvironmentX
IEwInteropFactoryX
Expand IEwLibraryManagerXIEwLibraryManagerX
Expand IEwLibraryXIEwLibraryX
Expand IEwLockStringXIEwLockStringX
Expand IEwManagerDialogXIEwManagerDialogX
Expand IEwManufacturerPartCircuitXIEwManufacturerPartCircuitX
Expand IEwManufacturerPartManagerXIEwManufacturerPartManagerX
Expand IEwManufacturerPartTerminalXIEwManufacturerPartTerminalX
Expand IEwManufacturerPartXIEwManufacturerPartX
Expand IEwMenuItemXIEwMenuItemX
Expand IEwMenuManagerXIEwMenuManagerX
Expand IEwMenuXIEwMenuX
Expand IEwNotificationDialogXIEwNotificationDialogX
Expand IEwObjectBaseXIEwObjectBaseX
IEwObjectDispatchX
Expand IEwObjectXIEwObjectX
Expand IEwPointXIEwPointX
Expand IEwProjectAutomaticArrowsXIEwProjectAutomaticArrowsX
Expand IEwProjectBookManagerXIEwProjectBookManagerX
IEwProjectBookX
Expand IEwProjectCableManagerXIEwProjectCableManagerX
Expand IEwProjectCableXIEwProjectCableX
Expand IEwProjectComponentCircuitXIEwProjectComponentCircuitX
Expand IEwProjectComponentManagerXIEwProjectComponentManagerX
Expand IEwProjectComponentTerminalXIEwProjectComponentTerminalX
Expand IEwProjectComponentXIEwProjectComponentX
Expand IEwProjectConfigurationXIEwProjectConfigurationX
Expand IEwProjectEntity3DManagerXIEwProjectEntity3DManagerX
Expand IEwProjectEntity3DXIEwProjectEntity3DX
Expand IEwProjectExcelAutomationXIEwProjectExcelAutomationX
Expand IEwProjectExportDWGFilesXIEwProjectExportDWGFilesX
Expand IEwProjectExportPDFXIEwProjectExportPDFX
Expand IEwProjectExportPDMXIEwProjectExportPDMX
Expand IEwProjectExportReportXIEwProjectExportReportX
Expand IEwProjectFileConfigurationManagerXIEwProjectFileConfigurationManagerX
Expand IEwProjectFileConfigurationXIEwProjectFileConfigurationX
Expand IEwProjectFileManagerXIEwProjectFileManagerX
Expand IEwProjectFileXIEwProjectFileX
Expand IEwProjectFolderManagerXIEwProjectFolderManagerX
Expand IEwProjectFolderXIEwProjectFolderX
Expand IEwProjectFunctionManagerXIEwProjectFunctionManagerX
Expand IEwProjectFunctionXIEwProjectFunctionX
Expand IEwProjectGenerateTSDrawingXIEwProjectGenerateTSDrawingX
Expand IEwProjectHarnessManagerXIEwProjectHarnessManagerX
Expand IEwProjectHarnessXIEwProjectHarnessX
Expand IEwProjectInputOutputManagerXIEwProjectInputOutputManagerX
Expand IEwProjectInputOutputXIEwProjectInputOutputX
Expand IEwProjectLocationManagerXIEwProjectLocationManagerX
Expand IEwProjectLocationXIEwProjectLocationX
Expand IEwProjectManagerXIEwProjectManagerX
IEwProjectManufacturerPartCircuitX
Expand IEwProjectManufacturerPartManagerXIEwProjectManufacturerPartManagerX
IEwProjectManufacturerPartTerminalX
Expand IEwProjectManufacturerPartXIEwProjectManufacturerPartX
Expand IEwProjectMultilingualTextFontXIEwProjectMultilingualTextFontX
Expand IEwProjectMultilingualTextManagerXIEwProjectMultilingualTextManagerX
Expand IEwProjectMultilingualTextXIEwProjectMultilingualTextX
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 IEwRibbonComboBoxControlXIEwRibbonComboBoxControlX
Expand IEwRibbonControlXIEwRibbonControlX
Expand IEwRibbonGroupXIEwRibbonGroupX
Expand IEwRibbonQuickAccessControlXIEwRibbonQuickAccessControlX
Expand IEwRibbonTabXIEwRibbonTabX
Expand IEwRibbonXIEwRibbonX
Expand IEwRightsManagerXIEwRightsManagerX
Expand IEwSaveDWGImageXIEwSaveDWGImageX
Expand IEwSelectorDialogXIEwSelectorDialogX
Expand IEwSymbolCircuitXIEwSymbolCircuitX
Expand IEwSymbolFiltersXIEwSymbolFiltersX
Expand IEwSymbolManagerXIEwSymbolManagerX
Expand IEwSymbolPointXIEwSymbolPointX
Expand IEwSymbolXIEwSymbolX
Expand IEwTerminalTypeManagerXIEwTerminalTypeManagerX
Expand IEwTerminalTypeXIEwTerminalTypeX
Expand IEwTitleBlockManagerXIEwTitleBlockManagerX
Expand IEwTitleBlockXIEwTitleBlockX
Expand IEwWireTerminationTypeManagerXIEwWireTerminationTypeManagerX
Expand IEwWireTerminationTypeXIEwWireTerminationTypeX
Expand IEwXLSBookXIEwXLSBookX
Expand IEwXLSSheetXIEwXLSSheetX
Expand IInteropFactoryXIInteropFactoryX
Class Index
Expand Class HierarchyClass Hierarchy
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 2023.0.0
Electrical API
Public Member Functions | List of all members
IEwClassX Interface Reference

Use this interface to manage an EwClassX object. More...

Inheritance diagram for IEwClassX:
Inheritance graph
[legend]

Public Member Functions

LONG getID ()
 
EwErrorCode setParentID (LONG lID)
 Set the value of parent ID. More...
 
LONG getParentID (EwErrorCode *errorCode)
 Return the ID of the parent of the class. More...
 
LONG getClassificationID (EwErrorCode *errorCode)
 Return classification ID. More...
 
LONG getClassID (EwErrorCode *errorCode)
 Return the class node Id, unique within the classification. More...
 
EwErrorCode set3DPartName (BSTR str3DPartName)
 Set the default 3D part to use when inserting a 3D part. More...
 
BSTR get3DPartName (EwErrorCode *errorCode)
 Get the default 3D part used if none is associated to a manufacturer part. More...
 
EwErrorCode set2DFootprintSymbolName (BSTR str2DFootprintSymbolName)
 Set the default 2D footprint symbol to use if none is associated to a manufacturer part. More...
 
BSTR get2DFootprintSymbolName (EwErrorCode *errorCode)
 Get the default 2D footprint symbol used if none is associated to a manufacturer part. More...
 
EwErrorCode set2DConnectionLabelSymbolName (BSTR str2DConnectionLabelSymbolName)
 Set the default connection label symbol to use when inserting a connection label. More...
 
BSTR get2DConnectionLabelSymbolName (EwErrorCode *errorCode)
 Get the default connection label symbol used if none is associated to a manufacturer part. More...
 
EwErrorCode setUserDataFile (BSTR strDataFileName)
 Set User Data File of node. More...
 
BSTR getUserDataFile (EwErrorCode *errorCode)
 Get User Data File of node. More...
 
EwErrorCode setClassID (EwClassificationType ewClassificationType)
 Set class id of current node in classification. More...
 
EwClassComponentType getComponentType (EwErrorCode *errorCode)
 Get Component Type of current node in classification. More...
 
EwErrorCode setComponentType (EwClassComponentType ewClassComponentType)
 Set Component Type of current node in classification. More...
 
- Public Member Functions inherited from IEwEnvironmentObjectX
DATE getCreationDate (EwErrorCode *errorCode)
 Get the creation date of the current object. More...
 
DATE getModificationDate (EwErrorCode *errorCode)
 Get the last modification date of the current object. More...
 
EwCreatorType getEwCreatorType (EwErrorCode *errorCode)
 Get the creator of the current object. More...
 
BSTR getModifiedBy (EwErrorCode *eErrorCode)
 Get the last user name that modified the current object. More...
 
BSTR getCreatedBy (EwErrorCode *eErrorCode)
 Get the user name that created 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 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 an EwClassX object.

Since
2021 SP0

Member Function Documentation

◆ get2DConnectionLabelSymbolName()

BSTR IEwClassX::get2DConnectionLabelSymbolName ( EwErrorCode *  errorCode)

Get the default connection label symbol used if none is associated to a manufacturer part.

Since
2021 SP0
Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR no error detected.
  • EW_UNDEFINED_ERROR if another error occurred.
Returns
the default 2D foot print symbol name.

◆ get2DFootprintSymbolName()

BSTR IEwClassX::get2DFootprintSymbolName ( EwErrorCode *  errorCode)

Get the default 2D footprint symbol used if none is associated to a manufacturer part.

Since
2021 SP0
Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR no error detected.
  • EW_UNDEFINED_ERROR if another error occurred.
Returns
str2DFootprintSymbolName the default 2D foot print symbol name.

◆ get3DPartName()

BSTR IEwClassX::get3DPartName ( EwErrorCode *  errorCode)

Get the default 3D part used if none is associated to a manufacturer part.

Since
2021 SP0
Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR no error detected.
  • EW_UNDEFINED_ERROR if another error occurred.
Returns
the default 3D part.

◆ getClassID()

LONG IEwClassX::getClassID ( EwErrorCode *  errorCode)

Return the class node Id, unique within the classification.

Since
2021 SP0
Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR no error detected.
  • EW_UNDEFINED_ERROR if another error occurred. return return the class node Id.

◆ getClassificationID()

LONG IEwClassX::getClassificationID ( EwErrorCode *  errorCode)

Return classification ID.

Since
2021 SP0
Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR no error detected.
  • EW_UNDEFINED_ERROR if another error occurred. return id of classification.

◆ getComponentType()

EwClassComponentType IEwClassX::getComponentType ( EwErrorCode *  errorCode)

Get Component Type of current node in classification.

Since
2021 SP0
Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR no error detected.
  • EW_UNDEFINED_ERROR if another error occurred.
Returns
ewClassificationType classification type

◆ getID()

LONG IEwClassX::getID ( )
Returns
Get the ID of the object used. -1 if the object is invalid.

◆ getParentID()

LONG IEwClassX::getParentID ( EwErrorCode *  errorCode)

Return the ID of the parent of the class.

Since
2021 SP0
Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR no error detected.
  • EW_UNDEFINED_ERROR if another error occurred. return the parent id of the class.

◆ getUserDataFile()

BSTR IEwClassX::getUserDataFile ( EwErrorCode *  errorCode)

Get User Data File of node.

Since
2021 SP0
Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR no error detected.
  • EW_UNDEFINED_ERROR if another error occurred.
Returns
strDataFileName file name of user data

◆ set2DConnectionLabelSymbolName()

EwErrorCode IEwClassX::set2DConnectionLabelSymbolName ( BSTR  str2DConnectionLabelSymbolName)

Set the default connection label symbol to use when inserting a connection label.

Since
2021 SP0
Parameters
[in]str2DConnectionLabelSymbolNamethe new default 2D foot print symbol name.
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR no error detected.
  • EW_UNDEFINED_ERROR if another error occurred.

◆ set2DFootprintSymbolName()

EwErrorCode IEwClassX::set2DFootprintSymbolName ( BSTR  str2DFootprintSymbolName)

Set the default 2D footprint symbol to use if none is associated to a manufacturer part.

Since
2021 SP0
Parameters
[in]str2DFootprintSymbolNamethe new default 2D foot print symbol name.
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR no error detected.
  • EW_BAD_INPUTS if it is not associated to a manufacturer part.
  • EW_UNDEFINED_ERROR if another error occurred.

◆ set3DPartName()

EwErrorCode IEwClassX::set3DPartName ( BSTR  str3DPartName)

Set the default 3D part to use when inserting a 3D part.

Since
2021 SP0
Parameters
[in]str3DPartNamethe new default 3D part to use.
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR no error detected.
  • EW_UNDEFINED_ERROR if another error occurred.

◆ setClassID()

EwErrorCode IEwClassX::setClassID ( EwClassificationType  ewClassificationType)

Set class id of current node in classification.

Since
2021 SP0
Parameters
[in]ewClassificationTypeclassification type
Returns
errorCode EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected.
  • EW_INVALID_OBJECT The classification connection doesn't exist.
  • EW_UNDEFINED_ERROR if another error occurred.

◆ setComponentType()

EwErrorCode IEwClassX::setComponentType ( EwClassComponentType  ewClassComponentType)

Set Component Type of current node in classification.

Since
2021 SP0
Parameters
[in]ewClassComponentTypeEwClassComponentType classification type
Returns
errorCode EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected.
  • EW_INVALID_OBJECT The classification connection doesn't exist.
  • EW_UNDEFINED_ERROR if another error occurred.

◆ setParentID()

EwErrorCode IEwClassX::setParentID ( LONG  lID)

Set the value of parent ID.

Since
2021 SP0
Parameters
[in]lIDnew parent ID.
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR no error detected.
  • EW_BAD_INPUTS if the language code is not supported.
  • EW_UNDEFINED_ERROR if another error occurred.

◆ setUserDataFile()

EwErrorCode IEwClassX::setUserDataFile ( BSTR  strDataFileName)

Set User Data File of node.

Since
2021 SP0
Parameters
[in]strDataFileNamefile name of user data
Returns
errorCode EwErrorCode enum type, can be:
  • EW_NO_ERROR no error detected.
  • EW_UNDEFINED_ERROR if another error occurred.
Generated on Thu Aug 25 2022 16:02:38 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: IEwClassX 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) 2023 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