Welcome
Expand Getting StartedGetting Started
Expand SOLIDWORKS API HelpSOLIDWORKS API Help
Collapse SOLIDWORKS Electrical API HelpSOLIDWORKS Electrical API Help
Expand Getting StartedGetting Started
Expand Release NotesRelease Notes
Collapse ClassesClasses
Collapse Class ListClass List
Expand _DIEwProjectXEvents_DIEwProjectXEvents
Expand IEwAddInIEwAddIn
Expand IEwAPIXIEwAPIX
IEwApplicationReactorX
Expand IEwApplicationSettingsXIEwApplicationSettingsX
Expand IEwApplicationXIEwApplicationX
Expand IEwArchiveEnvironmentXIEwArchiveEnvironmentX
Expand IEwCableCoreXIEwCableCoreX
Expand IEwCableReferenceManagerXIEwCableReferenceManagerX
Expand IEwCableReferenceXIEwCableReferenceX
Expand 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 IEwEnvironmentXIEwEnvironmentX
Expand IEwInteropFactoryXIEwInteropFactoryX
Expand IEwLibraryManagerXIEwLibraryManagerX
Expand IEwLibraryXIEwLibraryX
Expand IEwLockStringXIEwLockStringX
Expand IEwManufacturerPartCircuitXIEwManufacturerPartCircuitX
Expand IEwManufacturerPartManagerXIEwManufacturerPartManagerX
Expand IEwManufacturerPartTerminalXIEwManufacturerPartTerminalX
Expand IEwManufacturerPartXIEwManufacturerPartX
Expand IEwObjectBaseXIEwObjectBaseX
Expand IEwPointXIEwPointX
Expand IEwProjectAutomaticArrowsXIEwProjectAutomaticArrowsX
Expand IEwProjectBookManagerXIEwProjectBookManagerX
IEwProjectBookX
Expand IEwProjectCableManagerXIEwProjectCableManagerX
Expand IEwProjectCableXIEwProjectCableX
Expand IEwProjectComponentCircuitXIEwProjectComponentCircuitX
Expand IEwProjectComponentManagerXIEwProjectComponentManagerX
IEwProjectComponentTerminalX
Expand IEwProjectComponentXIEwProjectComponentX
Expand IEwProjectConfigurationXIEwProjectConfigurationX
Expand IEwProjectEntity3DManagerXIEwProjectEntity3DManagerX
Expand IEwProjectEntity3DXIEwProjectEntity3DX
Expand IEwProjectExcelAutomationXIEwProjectExcelAutomationX
Expand IEwProjectExportDWGFilesXIEwProjectExportDWGFilesX
Expand IEwProjectExportPDFXIEwProjectExportPDFX
Expand IEwProjectExportPDMXIEwProjectExportPDMX
Expand IEwProjectExportReportXIEwProjectExportReportX
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 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 IEwRibbonControlXIEwRibbonControlX
Expand IEwRibbonGroupXIEwRibbonGroupX
Expand IEwRibbonTabXIEwRibbonTabX
Expand IEwRibbonXIEwRibbonX
Expand IEwRightsManagerXIEwRightsManagerX
Expand IEwSymbolCircuitXIEwSymbolCircuitX
Expand IEwSymbolFiltersXIEwSymbolFiltersX
Expand IEwSymbolManagerXIEwSymbolManagerX
Expand IEwSymbolPointXIEwSymbolPointX
Expand IEwSymbolXIEwSymbolX
Expand IEwTitleBlockManagerXIEwTitleBlockManagerX
Expand IEwTitleBlockXIEwTitleBlockX
Expand IEwXLSBookXIEwXLSBookX
Expand IEwXLSSheetXIEwXLSSheetX
Class Index
Expand Class HierarchyClass Hierarchy
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
Expand Visual Lisp Compatible FunctionsVisual Lisp Compatible Functions
Hide Table of Contents
SOLIDWORKS Electrical API  2021.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:
[legend]

Public Member Functions

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 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...
 
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...
 
DATE getModificationDate (EwErrorCode *errorCode)
 Get modification date of current node in classification. More...
 
DATE getCreationDate (EwErrorCode *errorCode)
 Get creation date of current node in classification. More...
 
EwCreatorType getEwCreatorType (EwErrorCode *errorCode)
 Get the EwCreator enumeration type. More...
 
BSTR getModifiedBy (EwErrorCode *errorCode)
 Get modified by of node. 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 IEwObjectBaseX
EwErrorCode remove ()
 Remove the object from the current project. More...
 
EwErrorCode update ()
 Update the object inside the current project. More...
 
LONG getID ()
 

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]EwErrorCodeenum 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]EwErrorCodeenum 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

◆ getCreationDate()

DATE IEwClassX::getCreationDate ( EwErrorCode *  errorCode)

Get creation date 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
creationDate creaton date of node.

◆ getEwCreatorType()

EwCreatorType IEwClassX::getEwCreatorType ( EwErrorCode *  errorCode)

Get the EwCreator enumeration type.

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

◆ getModificationDate()

DATE IEwClassX::getModificationDate ( EwErrorCode *  errorCode)

Get modification date 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
modificationDate date of last modification.

◆ getModifiedBy()

BSTR IEwClassX::getModifiedBy ( EwErrorCode *  errorCode)

Get modified by 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
strModifiedBy modified by of node.

◆ getParentID()

LONG IEwClassX::getParentID ( EwErrorCode *  errorCode)

Return the ID of the parent of the class.

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

◆ getTranslatedData()

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

Get the value of a translated text.

Since
2021 SP0
Parameters
[in]nUserDataNumberNumber of the text to get
[in]strLanguageLanguage code of the text to get
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR no error detected.
  • EW_OUT_OF_SCOPE number out of the scope supported by the method
  • EW_BAD_INPUTS if the language code is not supported
  • EW_UNDEFINED_ERROR if another error occurred.
Returns
Value of the text to get

◆ 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. \Return 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]

◆ 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.

◆ setTranslatedData()

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

Set the value of a translated text.

Since
2021 SP0 Project must be opened to be able to call this method
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_NO_ERROR no error detected.
  • EW_OUT_OF_SCOPE number out of the scope supported by the method
  • 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 20 2020 08:40:16 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: 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) 2021 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.46