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
Collapse 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
IEwSymbolX Interface Reference

Use this interface to manage a symbol. More...

Inheritance diagram for IEwSymbolX:
[legend]

Public Member Functions

IEwSymbolCircuitX addEwSymbolCircuit (BSTR strCircuitCode, EwErrorCode *errorCode)
 Create and add a circuit in the symbol. More...
 
EwErrorCode deleteEwSymbolCircuitAt (LONG index)
 Delete a circuit from the symbol. More...
 
LONG getEwSymbolCircuitCount ()
 Count the number of circuit in this symbol. More...
 
IEwSymbolCircuitX getEwSymbolCircuitAt (LONG index, EwErrorCode *errorCode)
 Get a circuit inside the symbol. More...
 
BSTR getDescription (BSTR lgCode, EwErrorCode *errorCode)
 Get a description of the symbol. More...
 
EwErrorCode setDescription (BSTR lgCode, BSTR strValue)
 Set a description of the symbol. More...
 
LONG getID (EwErrorCode *errorCode)
 Get ID of the symbol. More...
 
BSTR getReference (EwErrorCode *errorCode)
 Get the reference of the symbol. More...
 
EwErrorCode setReference (BSTR strReference)
 Set the reference of the symbol. More...
 
BSTR getManufacturer (EwErrorCode *errorCode)
 Get the manufacturer of the symbol. More...
 
EwErrorCode setManufacturer (BSTR strManufacturer)
 Set the manufacturer of the symbol. More...
 
LONG getClassNodeID (EwErrorCode *errorCode)
 Get the classification node ID of the symbol. More...
 
EwErrorCode setClassNodeID (LONG lNodeId)
 Set the classification node ID of the symbol. More...
 
BSTR getLibraryCode (EwErrorCode *errorCode)
 Get the library code of the symbol. More...
 
EwErrorCode setLibraryCode (BSTR strLibraryCode)
 Set the library code of the symbol. More...
 
DATE getModificationDate (EwErrorCode *errorCode)
 Get the last modification date of the symbol. More...
 
DATE getCreationDate (EwErrorCode *errorCode)
 Get the creation date of the symbol. More...
 
EwCreatorType getEwCreatorType (EwErrorCode *errorCode)
 Get the creator of the symbol. More...
 
BSTR getRootMark (EwErrorCode *errorCode)
 Get the root mark of the symbol. More...
 
EwErrorCode setRootMark (BSTR strRootMark)
 Set the root mark of the symbol. More...
 
BSTR getName (EwErrorCode *errorCode)
 Get the name of the symbol. More...
 
EwErrorCode setName (BSTR strSymbolName)
 Set the name of the symbol. More...
 
EwSymbolType getEwSymbolType (EwErrorCode *errorCode)
 Get the type of the symbol. More...
 
EwErrorCode setEwSymbolType (EwSymbolType eSymbolType)
 Set the type of the symbol. More...
 
EwMeasurementType getEwMeasurementType (EwErrorCode *errorCode)
 Return the measurement type of the symbol. More...
 
EwErrorCode setEwMeasurementType (EwMeasurementType eMeasurementType)
 Set the measurement type of the symbol. More...
 
EwSymbolCrossRefType getEwSymbolCrossRefType (EwErrorCode *errorCode)
 Return the cross reference type of the symbol. More...
 
EwErrorCode setEwSymbolCrossRefType (EwSymbolCrossRefType eSymbolCrossRefType)
 Set the cross reference type of the symbol. More...
 
BSTR getAssociatedMacro (EwErrorCode *errorCode)
 Return the associated macro of the symbol. More...
 
EwErrorCode setAssociatedMacro (BSTR strAssociatedMacro)
 Set the associated macro of the symbol. More...
 
BSTR getStandard (EwErrorCode *errorCode)
 Get the standard of the symbol. More...
 
EwErrorCode setStandard (BSTR strStandard)
 Set the standard of the symbol. More...
 
VARIANT_BOOL isConnectionPointVisible (EwErrorCode *errorCode)
 Check if connection point are displayed. More...
 
EwErrorCode showConnectionPoint (VARIANT_BOOL bVisible)
 Show connection point. More...
 
EwErrorCode getDoNotRotateAttributes (VARIANT_BOOL *bRotate)
 Get value of option "Do not rotate attributes". More...
 
EwErrorCode setDoNotRotateAttributes (VARIANT_BOOL bRotate)
 Set value of option "Do not rotate attributes". More...
 
EwErrorCode insert ()
 Insert this object inside the current environment. More...
 
EwErrorCode update ()
 Update the object inside the current environment. More...
 
EwErrorCode remove ()
 Remove the object inside the current environment. More...
 
EwErrorCode insertFromDwg (BSTR strDwgFilePath)
 Insert the object inside the current environment. More...
 
BOOL isAlreadyOpened (EwErrorCode *errorCode)
 Check if the drawing is already opened. More...
 
IEwSymbolPointX addEwSymbolPoint (EwErrorCode *errorCode)
 Create and add a connection point for the symbol. More...
 
EwErrorCode deleteEwSymbolPoint (LONG index)
 Delete a connection point from the symbol. More...
 
LONG getEwSymbolPointCount ()
 Count the number of connection point in the symbol. More...
 
IEwSymbolPointX getEwSymbolPointAt (LONG index, EwErrorCode *errorCode)
 Get a connection point inside the symbol. 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...
 

Detailed Description

Use this interface to manage a symbol.

Since
2018 SP0

Member Function Documentation

◆ addEwSymbolCircuit()

IEwSymbolCircuitX IEwSymbolX::addEwSymbolCircuit ( BSTR  strCircuitCode,
EwErrorCode *  errorCode 
)

Create and add a circuit in the symbol.

Parameters
[in]strCircuitCodeThe type of circuit
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred
Returns
The cable core and added

◆ addEwSymbolPoint()

IEwSymbolPointX IEwSymbolX::addEwSymbolPoint ( EwErrorCode *  errorCode)

Create and add a connection point for the symbol.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred
Returns
The connection point created and added

◆ deleteEwSymbolCircuitAt()

EwErrorCode IEwSymbolX::deleteEwSymbolCircuitAt ( LONG  index)

Delete a circuit from the symbol.

Parameters
[in]indexThe index of circuit you want to delete
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_BAD_INPUTS if index is not valid

◆ deleteEwSymbolPoint()

EwErrorCode IEwSymbolX::deleteEwSymbolPoint ( LONG  index)

Delete a connection point from the symbol.

Parameters
[in]indexThe index of connection point you want to delete
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_BAD_INPUTS if index is not valid

◆ getAssociatedMacro()

BSTR IEwSymbolX::getAssociatedMacro ( EwErrorCode *  errorCode)

Return the associated macro of the symbol.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred
Returns
will contain the associated macro

◆ getClassNodeID()

LONG IEwSymbolX::getClassNodeID ( EwErrorCode *  errorCode)

Get the classification node ID of the symbol.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred
Returns
will contain the classification node id

◆ getCreatedBy()

BSTR IEwSymbolX::getCreatedBy ( EwErrorCode *  eErrorCode)

Get the user name that created the current object.

Since
2021
Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred
Returns
a string with the user name that created the current object

◆ getCreationDate()

DATE IEwSymbolX::getCreationDate ( EwErrorCode *  errorCode)

Get the creation date of the symbol.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred
Returns
will contain the creation date

◆ getDescription()

BSTR IEwSymbolX::getDescription ( BSTR  lgCode,
EwErrorCode *  errorCode 
)

Get a description of the symbol.

Parameters
[in]lgCodeThe language of the description you want to get (like 'en' for english or 'fr' for french )
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_BAD_INPUTS if lgCode is not valid
Returns
will contain the description in the symbol

◆ getDoNotRotateAttributes()

EwErrorCode IEwSymbolX::getDoNotRotateAttributes ( VARIANT_BOOL *  bRotate)

Get value of option "Do not rotate attributes".

Parameters
[out]pbRotateTrue if rotate is disable
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred

◆ getEwCreatorType()

EwCreatorType IEwSymbolX::getEwCreatorType ( EwErrorCode *  errorCode)

Get the creator of the symbol.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred
Returns
will contain the creator

◆ getEwMeasurementType()

EwMeasurementType IEwSymbolX::getEwMeasurementType ( EwErrorCode *  errorCode)

Return the measurement type of the symbol.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred
Returns
the measurement type

◆ getEwSymbolCircuitAt()

IEwSymbolCircuitX IEwSymbolX::getEwSymbolCircuitAt ( LONG  index,
EwErrorCode *  errorCode 
)

Get a circuit inside the symbol.

Parameters
[in]indexThe index of circuit you want to get
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_BAD_INPUTS if index is not valid
Returns
The circuit

◆ getEwSymbolCircuitCount()

LONG IEwSymbolX::getEwSymbolCircuitCount ( )

Count the number of circuit in this symbol.

Returns
The number of circuit or -1 if this object was not initialized

◆ getEwSymbolCrossRefType()

EwSymbolCrossRefType IEwSymbolX::getEwSymbolCrossRefType ( EwErrorCode *  errorCode)

Return the cross reference type of the symbol.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred
Returns
will contain the cross reference type

◆ getEwSymbolPointAt()

IEwSymbolPointX IEwSymbolX::getEwSymbolPointAt ( LONG  index,
EwErrorCode *  errorCode 
)

Get a connection point inside the symbol.

Parameters
[in]indexThe index of connection point you want to get
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_BAD_INPUTS if index is not valid
Returns
The connection point

◆ getEwSymbolPointCount()

LONG IEwSymbolX::getEwSymbolPointCount ( )

Count the number of connection point in the symbol.

Returns
The number of terminal or -1 if the object was not initialized

◆ getEwSymbolType()

EwSymbolType IEwSymbolX::getEwSymbolType ( EwErrorCode *  errorCode)

Get the type of the symbol.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred
Returns
will contain the symbol type

◆ getID()

LONG IEwSymbolX::getID ( EwErrorCode *  errorCode)

Get ID of the symbol.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred
Returns
will contain the ID of the symbol

◆ getLibraryCode()

BSTR IEwSymbolX::getLibraryCode ( EwErrorCode *  errorCode)

Get the library code of the symbol.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred
Returns
will contain the library code

◆ getManufacturer()

BSTR IEwSymbolX::getManufacturer ( EwErrorCode *  errorCode)

Get the manufacturer of the symbol.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred
Returns
will contain the symbol

◆ getModificationDate()

DATE IEwSymbolX::getModificationDate ( EwErrorCode *  errorCode)

Get the last modification date of the symbol.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred
Returns
will contain the last symbol

◆ getModifiedBy()

BSTR IEwSymbolX::getModifiedBy ( EwErrorCode *  eErrorCode)

Get the last user name that modified the current object.

Since
2020 SP0
Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred
Returns
a string with the user name that modified the current object

◆ getName()

BSTR IEwSymbolX::getName ( EwErrorCode *  errorCode)

Get the name of the symbol.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred
Returns
will contain the symbol name

◆ getReference()

BSTR IEwSymbolX::getReference ( EwErrorCode *  errorCode)

Get the reference of the symbol.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred
Returns
will contain the symbol

◆ getRootMark()

BSTR IEwSymbolX::getRootMark ( EwErrorCode *  errorCode)

Get the root mark of the symbol.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred
Returns
will contain the root mark

◆ getStandard()

BSTR IEwSymbolX::getStandard ( EwErrorCode *  errorCode)

Get the standard of the symbol.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred
Returns
will contain the standard

◆ insert()

EwErrorCode IEwSymbolX::insert ( )

Insert this object inside the current environment.

Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_BAD_INPUTS if name is empty
  • EW_CANNOT_CREATE_FILE if the dwg cannot be created
  • EW_OBJECT_ALREADY_INSERTED if this object already exists
  • EW_INSERTION_FAILED if the insertion failed
  • Error from insertFromDwg

◆ insertFromDwg()

EwErrorCode IEwSymbolX::insertFromDwg ( BSTR  strDwgFilePath)

Insert the object inside the current environment.

Based on an external DWG.

Parameters
[in]strDwgFilePathPath to the dwg file
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_NAME if the file title is empty
  • EW_FILE_NOT_FOUND if strDwgFilePath is not found
  • EW_CAN_NOT_WRITE if impossible to copy strDwgFilePath
  • EW_INSERTION_FAILED if the insertion failed
  • EW_OBJECT_ALREADY_INSERTED if the object already exists

◆ isAlreadyOpened()

BOOL IEwSymbolX::isAlreadyOpened ( EwErrorCode *  errorCode)

Check if the drawing is already opened.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred
Returns
True if the drawing is already opened else false

◆ isConnectionPointVisible()

VARIANT_BOOL IEwSymbolX::isConnectionPointVisible ( EwErrorCode *  errorCode)

Check if connection point are displayed.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred
Returns
True if visible else FALSE

◆ remove()

EwErrorCode IEwSymbolX::remove ( )

Remove the object inside the current environment.

Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred

◆ setAssociatedMacro()

EwErrorCode IEwSymbolX::setAssociatedMacro ( BSTR  strAssociatedMacro)

Set the associated macro of the symbol.

Parameters
[in]strAssociatedMacroThe associated macro you want to set
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred

◆ setClassNodeID()

EwErrorCode IEwSymbolX::setClassNodeID ( LONG  lNodeId)

Set the classification node ID of the symbol.

Parameters
[in]lNodeIdThe classification node id you want to set
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred

◆ setDescription()

EwErrorCode IEwSymbolX::setDescription ( BSTR  lgCode,
BSTR  strValue 
)

Set a description of the symbol.

Parameters
[in]lgCodeThe language of the description you want to set (like 'en' for english or 'fr' for french )
[in]strValueThe description you want to set
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_BAD_INPUTS if lgCode is not valid

◆ setDoNotRotateAttributes()

EwErrorCode IEwSymbolX::setDoNotRotateAttributes ( VARIANT_BOOL  bRotate)

Set value of option "Do not rotate attributes".

Parameters
[in]bRotateTrue if rotate is disable
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred

◆ setEwMeasurementType()

EwErrorCode IEwSymbolX::setEwMeasurementType ( EwMeasurementType  eMeasurementType)

Set the measurement type of the symbol.

Parameters
[in]eMeasurementTypeThe new measurement
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred

◆ setEwSymbolCrossRefType()

EwErrorCode IEwSymbolX::setEwSymbolCrossRefType ( EwSymbolCrossRefType  eSymbolCrossRefType)

Set the cross reference type of the symbol.

Parameters
[in]eSymbolCrossRefTypeThe cross reference you want to set
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred

◆ setEwSymbolType()

EwErrorCode IEwSymbolX::setEwSymbolType ( EwSymbolType  eSymbolType)

Set the type of the symbol.

Parameters
[in]eSymbolTypeThe type you want to set
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred

◆ setLibraryCode()

EwErrorCode IEwSymbolX::setLibraryCode ( BSTR  strLibraryCode)

Set the library code of the symbol.

Parameters
[in]strLibraryCodeThe library code you want to set
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred

◆ setManufacturer()

EwErrorCode IEwSymbolX::setManufacturer ( BSTR  strManufacturer)

Set the manufacturer of the symbol.

Parameters
[in]strManufacturerThe manufacturer you want to set
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred

◆ setName()

EwErrorCode IEwSymbolX::setName ( BSTR  strSymbolName)

Set the name of the symbol.

Parameters
[in]strSymbolNameThe name you want to set
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_BAD_INPUTS if forbidden characters ("*,/:;<=>?`|¦) in name or empty

◆ setReference()

EwErrorCode IEwSymbolX::setReference ( BSTR  strReference)

Set the reference of the symbol.

Parameters
[in]strReferenceThe reference you want to set
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred

◆ setRootMark()

EwErrorCode IEwSymbolX::setRootMark ( BSTR  strRootMark)

Set the root mark of the symbol.

Parameters
[in]strRootMarkThe root mark you want to set
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred

◆ setStandard()

EwErrorCode IEwSymbolX::setStandard ( BSTR  strStandard)

Set the standard of the symbol.

Parameters
[in]strStandardThe standard you want to set
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred

◆ showConnectionPoint()

EwErrorCode IEwSymbolX::showConnectionPoint ( VARIANT_BOOL  bVisible)

Show connection point.

Parameters
[in]bVisibleTrue if visible else FALSE
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred

◆ update()

EwErrorCode IEwSymbolX::update ( )

Update the object inside the current environment.

Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_DOES_NOT_EXIST_ERROR If object was not previously inserted
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_NOT_IMPLEMENTED Not implemented.
Generated on Thu Aug 20 2020 08:40:18 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: IEwSymbolX 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