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
IEwClassificationX Interface Reference

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

Inheritance diagram for IEwClassificationX:
Inheritance graph

Public Member Functions

LONG getID (EwErrorCode *errorCode)
 
LONG getEwClassCount (EwErrorCode *errorCode)
 Get number of class in this classification. More...
 
EwClassificationType getClassificationType (EwErrorCode *errorCode)
 Get classification's type. More...
 
IEwClassX findEwClassByID (LONG lClassId, EwErrorCode *errorCode)
 Get EwClassX find by id in current classification. More...
 
VARIANT getEwClassArray (EwErrorCode *errorCode)
 Get the classification's class array. More...
 
IEwClassX newEwClass (EwErrorCode *errorCode)
 Create a new node in electrical classification. More...
 
EwErrorCode set3DPartName (BSTR str3DPartName)
 Set a classification 3d part name. More...
 
BSTR get3DPartName (EwErrorCode *errorCode)
 Get a classification 3d part name. More...
 
EwErrorCode set2DFootprintSymbolName (BSTR str2DFootprintSymbolName)
 Set a classification 2D Footprint SymbolName. More...
 
BSTR get2DFootprintSymbolName (EwErrorCode *errorCode)
 Get a classification 2D Footprint SymbolName. More...
 
EwErrorCode set2DConnectionLabelSymbolName (BSTR str2DConnectionLabelSymbolName)
 Set a classification 2D Connection Label SymbolName. More...
 
BSTR get2DConnectionLabelSymbolName (EwErrorCode *errorCode)
 Get a classification 2D Connection Label SymbolName. More...
 
EwClassificationType getType (EwErrorCode *errorCode)
 Get an EwClassificationType enumeration type. More...
 
EwErrorCode moveClass (long lClassId, long lClassIdParent)
 Move a class in the classification (change parent). 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 an IEwClassificationX object.

Since
2021 SP0

Member Function Documentation

◆ findEwClassByID()

IEwClassX IEwClassificationX::findEwClassByID ( LONG  lClassId,
EwErrorCode errorCode 
)

Get EwClassX find by id in current classification.

Since
2021 SP0
Parameters
[in]lClassIdthe class ID to find.
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected.
  • EW_UNDEFINED_ERROR if another error occurred.
Returns
an EwClassX interface from an ID. NULL otherwise.

◆ get2DConnectionLabelSymbolName()

BSTR IEwClassificationX::get2DConnectionLabelSymbolName ( EwErrorCode errorCode)

Get a classification 2D Connection Label SymbolName.

Since
2021 SP0
Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected.
  • EW_UNDEFINED_ERROR if another error occurred.
Returns
str2DConnectionLabelSymbolName name of 2D Connection Label SymbolName

◆ get2DFootprintSymbolName()

BSTR IEwClassificationX::get2DFootprintSymbolName ( EwErrorCode errorCode)

Get a classification 2D Footprint SymbolName.

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

◆ get3DPartName()

BSTR IEwClassificationX::get3DPartName ( EwErrorCode errorCode)

Get a classification 3d part name.

Since
2021 SP0
Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected.
  • EW_UNDEFINED_ERROR if another error occurred.
Returns
str3DPartName name of 3d part

◆ getClassificationType()

EwClassificationType IEwClassificationX::getClassificationType ( EwErrorCode errorCode)

Get classification's type.

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

◆ getEwClassArray()

VARIANT IEwClassificationX::getEwClassArray ( EwErrorCode errorCode)

Get the classification's class array.

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

◆ getEwClassCount()

LONG IEwClassificationX::getEwClassCount ( EwErrorCode errorCode)

Get number of class in this classification.

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

◆ getID()

LONG IEwClassificationX::getID ( EwErrorCode errorCode)

◆ getType()

EwClassificationType IEwClassificationX::getType ( EwErrorCode errorCode)

Get an EwClassificationType enumeration type.

Since
2021 SP0
Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected.
  • EW_UNDEFINED_ERROR if another error occurred.
Returns
EwClassificationType enumeration type, can be:
  • kComponentType
  • kCableReferenceType
  • kMacroType
  • kTitleBlockType

◆ moveClass()

EwErrorCode IEwClassificationX::moveClass ( long  lClassId,
long  lClassIdParent 
)

Move a class in the classification (change parent).

Since
2021 SP0
Parameters
[in]lClassIdthe ClassId id of class to move
[in]lClassIdParentthe lClassIdParent id of class to move
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected.
  • EW_BAD_INPUTS if param is not valid.
  • EW_UNDEFINED_ERROR if another error occurred.

◆ newEwClass()

IEwClassX IEwClassificationX::newEwClass ( EwErrorCode errorCode)

Create a new node in electrical classification.

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

◆ set2DConnectionLabelSymbolName()

EwErrorCode IEwClassificationX::set2DConnectionLabelSymbolName ( BSTR  str2DConnectionLabelSymbolName)

Set a classification 2D Connection Label SymbolName.

Since
2021 SP0
Parameters
[in]str2DConnectionLabelSymbolNameName of 2D footprint
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected.
  • EW_UNDEFINED_ERROR if another error occurred.

◆ set2DFootprintSymbolName()

EwErrorCode IEwClassificationX::set2DFootprintSymbolName ( BSTR  str2DFootprintSymbolName)

Set a classification 2D Footprint SymbolName.

Since
2021 SP0
Parameters
[in]str2DFootprintSymbolNamename of 2d footprint
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected.
  • EW_UNDEFINED_ERROR if another error occurred.

◆ set3DPartName()

EwErrorCode IEwClassificationX::set3DPartName ( BSTR  str3DPartName)

Set a classification 3d part name.

Since
2021 SP0
Parameters
[in]str3DPartNamename of 3d part
Returns
errorCode EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected.
  • EW_UNDEFINED_ERROR if another error occurred.


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: IEwClassificationX 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.