Welcome
Expand Getting StartedGetting Started
Expand SOLIDWORKS API HelpSOLIDWORKS API Help
Collapse SOLIDWORKS Electrical API HelpSOLIDWORKS Electrical API Help
Expand Getting StartedGetting Started
Collapse ClassesClasses
Expand Class ListClass List
Class Index
Collapse Class HierarchyClass Hierarchy
_DIEwProjectXEvents
Collapse IDispatchIDispatch
IEwAddIn
IEwAPIX
IEwApplicationReactorX
IEwApplicationSettingsX
IEwApplicationX
IEwArchiveEnvironmentX
IEwCableCoreX
IEwCableReferenceManagerX
IEwCableReferenceX
IEwCommandContextX
IEwCommandManagerX
IEwCommandX
IEwDialogAlignPartsParametersSelectorX
IEwDialogLocationSelectorX
IEwDialogMacroSelectorX
IEwDialogManufacturerPartOrderingX
IEwDialogManufacturerPartSelectorX
IEwDialogProgressX
IEwDialogProjectManagerX
IEwDialogResumeX
IEwDialogSummaryX
IEwDialogTaskX
IEwEnvironmentX
IEwInteropFactoryX
IEwLibraryManagerX
IEwLibraryX
IEwLockStringX
IEwManufacturerPartCircuitX
IEwManufacturerPartManagerX
IEwManufacturerPartTerminalX
IEwManufacturerPartX
Expand IEwObjectBaseXIEwObjectBaseX
IEwPointX
IEwProjectAutomaticArrowsX
IEwProjectBookManagerX
IEwProjectCableManagerX
IEwProjectComponentCircuitX
IEwProjectComponentManagerX
IEwProjectComponentTerminalX
IEwProjectEntity3DManagerX
IEwProjectExportDWGFilesX
IEwProjectExportPDMX
IEwProjectExportReportX
IEwProjectFileManagerX
IEwProjectFolderManagerX
IEwProjectFunctionManagerX
IEwProjectGenerateTSDrawingX
IEwProjectHarnessManagerX
IEwProjectLocationManagerX
IEwProjectManagerX
IEwProjectManufacturerPartCircuitX
IEwProjectManufacturerPartManagerX
IEwProjectManufacturerPartTerminalX
IEwProjectManufacturerPartX
IEwProjectNumberDocumentsX
IEwProjectNumberMarksX
IEwProjectNumberWiresX
IEwProjectOptimizeWireOrderX
IEwProjectPrintConfigManagerX
IEwProjectReportManagerX
IEwProjectSnapshotManagerX
IEwProjectSnapshotX
IEwProjectSymbolManagerX
IEwProjectUpdateReplaceDataX
IEwProjectWireManagerX
IEwProjectX
IEwResumeRowX
IEwRibbonControlX
IEwRibbonGroupX
IEwRibbonTabX
IEwRibbonX
IEwRightsManagerX
IEwSymbolCircuitX
IEwSymbolFiltersX
IEwSymbolManagerX
IEwSymbolPointX
IEwSymbolX
IEwTitleBlockManagerX
IEwTitleBlockX
IEwXLSBookX
IEwXLSSheetX
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
Hide Table of Contents
SOLIDWORKS Electrical API  2020.0.5
Electrical API
Public Member Functions | List of all members
IEwSymbolManagerX Interface Reference

Use this interface to manage EwSymbolX objects. More...

Inheritance diagram for IEwSymbolManagerX:
[legend]

Public Member Functions

IEwSymbolX newEwSymbol ()
 Create a IEwSymbolX object from the associated environnement. More...
 
LONG getCount ()
 
VARIANT getEwSymbolArray (EwErrorCode *errorCode)
 return the array of IEwSymbolX of associated environment More...
 
IEwSymbolFiltersX newEwSymbolFilters ()
 Create a IEwSymbolFiltesrX object to get symbols af associated environment. More...
 
IEwSymbolX at (int iIndex, EwErrorCode *errorCode)
 Return an IEwSymbolX at a given position from the associated environment. More...
 
IEwSymbolX findEwSymbolXById (long lId, EwErrorCode *pErrorCode)
 Find an IEwSymbolX by ID. More...
 
IEwSymbolX findEwSymbolXByName (BSTR strName, EwErrorCode *errorCode)
 Find an IEwSymbolX by his Name. More...
 

Detailed Description

Use this interface to manage EwSymbolX objects.

Since
2018 SP0

Member Function Documentation

◆ at()

IEwSymbolX IEwSymbolManagerX::at ( int  iIndex,
EwErrorCode *  errorCode 
)

Return an IEwSymbolX at a given position from the associated environment.

Parameters
[in]iIndexin the array of symbols
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_INVALID_OBJECT Object is not initialized
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_BAD_INPUT if another error occurred
Returns
A valid IEwSymbolX if index is valid. null otherwise.

◆ findEwSymbolXById()

IEwSymbolX IEwSymbolManagerX::findEwSymbolXById ( long  lId,
EwErrorCode *  pErrorCode 
)

Find an IEwSymbolX by ID.

since 2020 SP0

Remarks
this method will load the symbols in memory the first time it is called. So it can takes time. All futur calls will be faster.
Parameters
[in]lIdid of symbol to find
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_INVALID_OBJECT Object is not initialized
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_BAD_INPUT if another error occurred
Returns
A valid IEwSymbolX or null if not found.

◆ findEwSymbolXByName()

IEwSymbolX IEwSymbolManagerX::findEwSymbolXByName ( BSTR  strName,
EwErrorCode *  errorCode 
)

Find an IEwSymbolX by his Name.

since 2020 SP0

Parameters
[in]strNamethe name of symbol to find. Mustn't be empty.
Remarks
compare to findEwSymbolXById, this method is not loading all symbols in memory but get the symbol directly from the database.
Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_BAD_INPUT if name is empty
  • EW_OBJECT_NOT_FOUND if no symbol with this same has been found
Returns
A valid IEwSymbolX or null if not found.

◆ getCount()

LONG IEwSymbolManagerX::getCount ( )
Returns
the number of symbols of associated environment

◆ getEwSymbolArray()

VARIANT IEwSymbolManagerX::getEwSymbolArray ( EwErrorCode *  errorCode)

return the array of IEwSymbolX of associated environment

◆ newEwSymbol()

IEwSymbolX IEwSymbolManagerX::newEwSymbol ( )

Create a IEwSymbolX object from the associated environnement.

Returns
An IEwSymbolX connected to the associated environnement

◆ newEwSymbolFilters()

IEwSymbolFiltersX IEwSymbolManagerX::newEwSymbolFilters ( )

Create a IEwSymbolFiltesrX object to get symbols af associated environment.

Returns
An IEwSymbolFiltersX object to get symbols af associated environment
Generated on Tue Sep 1 2020 17:01:25 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: IEwSymbolManagerX 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) 2020 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