Hide Table of Contents
SOLIDWORKS Electrical API  2021.0.0
Electrical API
EnumDefinition.idl File Reference

Go to the source code of this file.

Enumerations

enum  EwErrorCode {
  EW_NOT_IMPLEMENTED = -1, EW_NO_ERROR = 0, EW_UNDEFINED_ERROR = 1, EW_BAD_INPUTS = 2,
  EW_FILE_NOT_FOUND = 3, EW_INVALID_FILE = 4, EW_CAN_NOT_WRITE = 5, EW_DATABASE_CONNECTION_ERROR = 6,
  EW_DATABASE_CREATION_ERROR = 7, EW_DOES_NOT_EXIST_ERROR = 8, EW_INVALID_OBJECT = 9, EW_INVALID_CALL = 10,
  EW_CANNOT_COPY_FILE = 11, EW_CANNOT_CREATE_FILE = 12, EW_OBJECT_ALREADY_INSERTED = 13, EW_INSERTION_FAILED = 14,
  EW_OBJECT_ALREADY_EXISTS = 15, EW_INVALID_NAME = 16, EW_FOLDER_ISNOT_EMPTY = 17, EW_INVALID_CONNECTIONTYPE = 18,
  EW_NO_ACTIVEPROJECT = 19, EW_PROJECT_NOTOPENED = 20, EW_OUT_OF_MEMORY = 21, EW_OBJECT_NOT_FOUND = 22,
  EW_CANNOT_CONNECT = 23, EW_INVALID_ID = 24, EW_OUT_OF_SCOPE = 25, EW_API_NOT_SUPPORTED = 26,
  EW_CANNOT_OPEN_PROJECT = 27, EW_CANNOT_CLOSE_PROJECT = 28, EW_OPERATION_CANCELED = 29, EW_NO_IMPORT_LIBRARY_EXIST = 30,
  EW_CANNOT_INITIALIZE = 31, EW_CANNOT_CONNECT_PARSER = 32, EW_MACROFILTERS_NOT_INITIALIZED = 33, EW_INVALID_INDEX = 34,
  EW_CANNOT_REMOVE = 35, EW_FILE_FROM_HIGHER_VERSION = 36, EW_FOLDER_NOT_FOUND = 37, EW_NO_ENVIRONMENT_AVAILABLE = 38,
  EW_INVALID_LICENSE = 39, EW_LICENSE_WITHOUT_API_OPTION = 40, EW_ERROR_WINDCHILL_LICENSE = 41, EW_NO_PROJECT_OPENED_BY_SOMEONE_ELSE = 42,
  EW_CANNOT_DROP_DATABASE = 43, EW_CANNOT_DELETE_FOLDER = 44, EW_PROJECT_OPENED = 45, EW_INVALID_RIGHT = 46,
  EW_ALREADY_OPEN = 47, EW_CANNOT_OPEN = 48, EW_CANNOT_CLOSE = 49, EW_INVALID_USER = 50,
  EW_NO_DATA = 51, EW_NO_WRITE_PERMISSION = 52
}
 All errors codes for this API. More...
 
enum  EwBooleanFiltersValue { kFilterTrue = 0, kFilterFalse = 1, kFilterBoth = 2 }
 All value for boolean filters. More...
 
enum  EwAppNotify {
  kEwAppNotifyOnOpenProject = 1, kEwAppNotifyOnSetActiveProjecy = 2, kEwAppNotifyOnBeforeCloseProject = 3, kEwAppNotifyOnAfterCloseProject = 4,
  kEwAppNotifyOnCloseApplication = 5
}
 All the application reactors IDs. More...
 
enum  EwEnvironmentNotify {
  kEwEnvironmentNotifyOnOpenConnection = 1, kEwEnvironmentNotifyOnCloseConnection = 2, kEwEnvironmentNotifyOnLostConnection = 3, kEwEnvironmentNotifyOnProjectObjectAdd = 4,
  kEwEnvironmentNotifyOnProjectObjectUpdate = 5, kEwEnvironmentNotifyOnProjectObjectDelete = 6
}
 All the environment reactors IDs. More...
 
enum  EwProjectNotify {
  kEwProjectNotifyOnOpenConnection = 1, kEwProjectNotifyOnCloseConnection = 2, kEwProjectNotifyOnLostConnection = 3, kEwProjectNotifyOnProjectObjectAdd = 4,
  kEwProjectNotifyOnProjectObjectUpdate = 5, kEwProjectNotifyOnProjectObjectDelete = 6
}
 All the project reactors IDs. More...
 
enum  EwProjecManagerDialogNotify { kEwProjecManagerDialogNotifyOnOpen = 1, kEwProjecManagerDialogNotifyOnSelectChange = 2, kEwProjecManagerDialogNotifyOnClose = 3 }
 All the project manager dialog reactors IDs. More...
 
enum  EwIconIndex { kUnkownIcon = -1, kIconHelp = 0 }
 Default icons. More...
 
enum  EwTextIdentifer { kTextIdentiferUnknown = -1, kTextIdentiferNone = 0, kTextIdentiferSingleQuote = 1, kTextIdentiferDoubleQuote = 2 }
 Text identifier options. More...
 
enum  EwTextSeparator { kTextSeparatorUnknown = -1, kTextSeparatorTabulation = 0, kTextSeparatorComma = 1, kTextSeparatorSemiColumn = 2 }
 Text separator options. More...
 
enum  EwRibbonControlType {
  kControlError = -1, kControlButton = 0, kControlPopup = 1, kControlButtonPopup = 2,
  kControlSplitButtonPopup = 3, kControlComboBox = 4, kControlEdit = 5, kControlCustom = 6,
  kControlLabel = 7, kControlCheckBox = 8, kControlGallery = 9, kControlRadioButton = 10
}
 Type of the control that can be used in a ribbon. More...
 
enum  EwRibbonButtonStyle {
  kButtonUndefined = -1, kButtonAutomatic = 0, kButtonCaption = 1, kButtonIcon = 2,
  kButtonIconAndCaption = 3, kButtonIconAndCaptionBelow = 4, kButtonCaptionAndDescription = 5
}
 Ribbon bar button's styles. More...
 
enum  EwRibbonButtonSize {
  kButtonSizeUndefined = -1, kButtonSize16 = 0, kButtonSize20 = 1, kButtonSize24 = 2,
  kButtonSize32 = 3, kButtonSize40 = 4, kButtonSize48 = 5, kButtonSize64 = 6,
  kButtonSize80 = 7
}
 Ribbon bar button's styles. More...
 
enum  EwNumberWireAction {
  kNumberWireActionUndefined = -1, kNumberNewWiresAction = 0, kNumberNewWiresAndRecalculateMarksAction = 1, kReNumberWiresAction = 2,
  kRemoveNumberWiresAction = 3
}
 All the possible actions for renumber wires. More...
 
enum  EwSelectionType {
  kSelectionUndefined = -1, kSelectionAll = 0, kSelectionBook = 1, kSelectionFolder = 2,
  kSelectionScheme = 3
}
 All the selection types. More...
 
enum  EwApISoftType { kSoftTypeUndefined = -1, kSoftType2DEW = 0, kSoftType2DSW = 1, kSoftType3DSW = 3 }
 All the selection types. More...
 
enum  EwDockingPaneDirection {
  EwPaneDockUnknown = -1, EwPaneDockLeft = 0, EwPaneDockRight = 1, EwPaneDockTop = 2,
  EwPaneDockBottom = 3, EwPaneDockMiniWnd = 4
}
 Docking Pane direction enumeration. More...
 
enum  EwDockingPaneStandard {
  EwDockingPaneUnknown = -1, EwDockingPaneResources = 0, EwDockingPaneTutorial = 1, EwDockingPaneProperties = 2,
  EwDockingPaneComponents = 3, EwDockingPaneConnectionLabel = 4, EwDockingPaneDocuments = 5, EwDockingPaneCabinetLayout = 6,
  EwDockingPaneMacros = 7, EwDockingPaneCommand = 8, EwDockingPaneSymbols = 9
}
 Standard Docking Pane. More...
 

Variables

enum EwErrorCode EwErrorCode
 
enum EwBooleanFiltersValue EwBooleanFiltersValue
 
enum EwAppNotify EwAppNotify
 
enum EwEnvironmentNotify EwEnvironmentNotify
 
enum EwProjectNotify EwProjectNotify
 
enum EwProjecManagerDialogNotify EwProjecManagerDialogNotify
 
enum EwIconIndex EwIconIndex
 
enum EwTextIdentifer EwTextIdentifer
 
enum EwTextSeparator EwTextSeparator
 
enum EwRibbonControlType EwRibbonControlType
 
enum EwRibbonButtonStyle EwRibbonButtonStyle
 
enum EwRibbonButtonSize EwRibbonButtonSize
 
enum EwNumberWireAction EwNumberWireAction
 
enum EwSelectionType EwSelectionType
 
enum EwApISoftType EwApISoftType
 
enum EwDockingPaneDirection EwDockingPaneDirection
 
enum EwDockingPaneStandard EwDockingPaneStandard
 

Enumeration Type Documentation

◆ EwApISoftType

All the selection types.

Since
2020
Enumerator
kSoftTypeUndefined 

Unfefined selection.

kSoftType2DEW 

elecworks 2d.

kSoftType2DSW 

Solidworks electrical 2d.

kSoftType3DSW 

Solidworks electrical 3d.

◆ EwAppNotify

All the application reactors IDs.

Enumerator
kEwAppNotifyOnOpenProject 

Open project notification.

kEwAppNotifyOnSetActiveProjecy 

Set active project notification.

kEwAppNotifyOnBeforeCloseProject 

Close project Pre notification.

kEwAppNotifyOnAfterCloseProject 

Close project Post notification.

kEwAppNotifyOnCloseApplication 

Close application notification.

◆ EwBooleanFiltersValue

All value for boolean filters.

Enumerator
kFilterTrue 

Filter true.

kFilterFalse 

Filter false.

kFilterBoth 

True AND false value.

◆ EwDockingPaneDirection

Docking Pane direction enumeration.

Since
2021 SP0
Enumerator
EwPaneDockUnknown 

Docking pane direction is unspecified.

EwPaneDockLeft 

To dock the pane to the left of the pane.

EwPaneDockRight 

To dock the pane to the right of the pane.

EwPaneDockTop 

To dock the pane to the top of the pane.

EwPaneDockBottom 

To dock the pane to the bottom of the pane.

EwPaneDockMiniWnd 

Docking pane is floating mini frame window.

◆ EwDockingPaneStandard

Standard Docking Pane.

Since
2021 SP1
Enumerator
EwDockingPaneUnknown 

Docking pane is unspecified.

EwDockingPaneResources 

Resources Docking pane.

EwDockingPaneTutorial 

Tutorial Docking pane.

EwDockingPaneProperties 

Properties Docking pane.

EwDockingPaneComponents 

Components Docking pane.

EwDockingPaneConnectionLabel 

Connection Label Docking pane.

EwDockingPaneDocuments 

Documents Docking pane.

EwDockingPaneCabinetLayout 

Cabinet Layout Docking pane.

EwDockingPaneMacros 

Macros Docking pane.

EwDockingPaneCommand 

Command Docking pane.

EwDockingPaneSymbols 

Symbols Docking pane.

◆ EwEnvironmentNotify

All the environment reactors IDs.

Enumerator
kEwEnvironmentNotifyOnOpenConnection 

Environment connection opened notification.

kEwEnvironmentNotifyOnCloseConnection 

Environment connection closed notification.

kEwEnvironmentNotifyOnLostConnection 

Environment connection lost notification.

kEwEnvironmentNotifyOnProjectObjectAdd 

Object added.

kEwEnvironmentNotifyOnProjectObjectUpdate 

Object update.

kEwEnvironmentNotifyOnProjectObjectDelete 

Object delete.

◆ EwErrorCode

All errors codes for this API.

Enumerator
EW_NOT_IMPLEMENTED 

Method not implemented.

EW_NO_ERROR 

Success.

EW_UNDEFINED_ERROR 

Undefined error.

EW_BAD_INPUTS 

The functions parameters are invalid.

EW_FILE_NOT_FOUND 

File not found.

EW_INVALID_FILE 

Invalid file

EW_CAN_NOT_WRITE 

Cannot write in output (file, folder, network,etc...)

EW_DATABASE_CONNECTION_ERROR 

Cannot connect to a database.

EW_DATABASE_CREATION_ERROR 

Cannot create database.

EW_DOES_NOT_EXIST_ERROR 

Doesn't exist.

EW_INVALID_OBJECT 

Object invalid or not initialized.

EW_INVALID_CALL 

Impossible to call this method.

EW_CANNOT_COPY_FILE 

Cannot copy file.

EW_CANNOT_CREATE_FILE 

Cannot create a new file.

EW_OBJECT_ALREADY_INSERTED 

This object has already been inserted.

EW_INSERTION_FAILED 

Insertion of object failed see Query log for more details.

EW_OBJECT_ALREADY_EXISTS 

This already exists.

EW_INVALID_NAME 

Invalid name, can be empty or containing invalid characters.

EW_FOLDER_ISNOT_EMPTY 

Destination folder is not empty but it must empty.

EW_INVALID_CONNECTIONTYPE 

Database connection type is invalid to execute this operation.

EW_NO_ACTIVEPROJECT 

No active project.

EW_PROJECT_NOTOPENED 

Project not opened.

EW_OUT_OF_MEMORY 

Allocating too much memory.

EW_OBJECT_NOT_FOUND 

Cannot find this object.

EW_CANNOT_CONNECT 

Cannot connect to database, collaborative server or user rights.

EW_INVALID_ID 

ID not found.

EW_OUT_OF_SCOPE 

The Number of the user data is out of the scope of the user data of the object (usually between 0 and 20)

EW_API_NOT_SUPPORTED 

API not supported for this application.

EW_CANNOT_OPEN_PROJECT 

Cannot open project.

EW_CANNOT_CLOSE_PROJECT 

Cannot close project.

EW_OPERATION_CANCELED 

The operation, dialog, etc...

has been canceled

EW_NO_IMPORT_LIBRARY_EXIST 

The Library object is not found.

EW_CANNOT_INITIALIZE 

The CAD Engine is not initialized or application is in Beta.

EW_CANNOT_CONNECT_PARSER 

The Parser Engine is not registered.

EW_MACROFILTERS_NOT_INITIALIZED 

Before show the Macro selector Dialog, macro filters must be initialized.

EW_INVALID_INDEX 

The index of the array in not valid, bigger than size.

EW_CANNOT_REMOVE 

Cannot remove an object, look at description of object for details.

EW_FILE_FROM_HIGHER_VERSION 

Version in archive is higher than you can open with your software.

EW_FOLDER_NOT_FOUND 

Folder not found.

EW_NO_ENVIRONMENT_AVAILABLE 

Environment not available.

EW_INVALID_LICENSE 

The licence number is not a valid licence.

EW_LICENSE_WITHOUT_API_OPTION 

The license doesn't have option to run API.

EW_ERROR_WINDCHILL_LICENSE 

An error with windchill license occured, can be no license, expired license, license doesn't have wind chill option, all licenses are used.

EW_NO_PROJECT_OPENED_BY_SOMEONE_ELSE 

Project opened by someone else from another computer.

Use collaborative server to identify who is using it.

EW_CANNOT_DROP_DATABASE 

SQL Database cannot be deleted.

EW_CANNOT_DELETE_FOLDER 

Folder cannot be deleted.

EW_PROJECT_OPENED 

Project is opened.

Since
2019
EW_INVALID_RIGHT 

If the current user does not have the good right to use feature.

Since
2020 SP0
EW_ALREADY_OPEN 

If the current object is already open by another.

Since
2019 SP2
EW_CANNOT_OPEN 

Cannot open file, ...

EW_CANNOT_CLOSE 

Cannot close files, ...

EW_INVALID_USER 

If the user rights management found an invalid login/passord.

Since
2020 SP0
EW_NO_DATA 

If they are no data in the zip, object, ...

Since
2020 SP0
EW_NO_WRITE_PERMISSION 

If the user have not the write permission.

Since
2020 SP1

◆ EwIconIndex

Default icons.

Enumerator
kUnkownIcon 

Icon not defined.

kIconHelp 

Help icon.

◆ EwNumberWireAction

All the possible actions for renumber wires.

Since
2019
Enumerator
kNumberWireActionUndefined 

Unknown action.

kNumberNewWiresAction 

Only new wires are numbered.

kNumberNewWiresAndRecalculateMarksAction 

Number new wires and formula of existing wires will be recalculated.

kReNumberWiresAction 

Renumber all wires.

kRemoveNumberWiresAction 

All wire numbers are deleted.

◆ EwProjecManagerDialogNotify

All the project manager dialog reactors IDs.

Enumerator
kEwProjecManagerDialogNotifyOnOpen 

Open project manager dialog notification.

kEwProjecManagerDialogNotifyOnSelectChange 

Project selection changed for project manager dialog notification.

kEwProjecManagerDialogNotifyOnClose 

Close project manager dialog notification.

◆ EwProjectNotify

All the project reactors IDs.

Enumerator
kEwProjectNotifyOnOpenConnection 

Project connection opened notification.

kEwProjectNotifyOnCloseConnection 

Project connection closed notification.

kEwProjectNotifyOnLostConnection 

Project connection lost notification.

kEwProjectNotifyOnProjectObjectAdd 

Project object added.

kEwProjectNotifyOnProjectObjectUpdate 

Project object update.

kEwProjectNotifyOnProjectObjectDelete 

Project object delete.

◆ EwRibbonButtonSize

Ribbon bar button's styles.

Since
2019
Enumerator
kButtonSizeUndefined 

Default size for image 32x32.

kButtonSize16 

Size for image 16x16.

kButtonSize20 

Size for image 20x20.

kButtonSize24 

Size for image 24x24.

kButtonSize32 

Size for image 32x32.

kButtonSize40 

Size for image 40x40.

kButtonSize48 

Size for image 48x48.

kButtonSize64 

Size for image 64x64.

kButtonSize80 

Size for image 80x80.

◆ EwRibbonButtonStyle

Ribbon bar button's styles.

Since
2019
Enumerator
kButtonUndefined 

Automatic style.

kButtonAutomatic 

Automatic style.

kButtonCaption 

Button draw only caption.

kButtonIcon 

Button draw only icon.

kButtonIconAndCaption 

Button draw icon and caption.

kButtonIconAndCaptionBelow 

Button draw icon and draw caption below icon.

kButtonCaptionAndDescription 

Button draw icon, caption and description for popup bar.

◆ EwRibbonControlType

Type of the control that can be used in a ribbon.

Since
2019
Enumerator
kControlError 

Type is not defined.

kControlButton 

Button type.

kControlPopup 

Popup type.

kControlButtonPopup 

Button popup.

kControlSplitButtonPopup 

Split button popup.

kControlComboBox 

Combo box button.

kControlEdit 

Edit control.

kControlCustom 

Custom control.

kControlLabel 

Label control.

kControlCheckBox 

CheckBox control.

kControlGallery 

Gallery control.

kControlRadioButton 

Radio Button control.

◆ EwSelectionType

All the selection types.

Since
2019
Enumerator
kSelectionUndefined 

Unknown selection.

kSelectionAll 

All the project is selected.

kSelectionBook 

Selection of specified books.

kSelectionFolder 

Selection of specified folders.

kSelectionScheme 

Selection of specified schemes.

◆ EwTextIdentifer

Text identifier options.

Enumerator
kTextIdentiferUnknown 

Unknown text identifier.

kTextIdentiferNone 

No Text Identifer.

kTextIdentiferSingleQuote 

Text Identifer whith single Quote '-—'.

kTextIdentiferDoubleQuote 

Text Identifer whith double Quote "----".

◆ EwTextSeparator

Text separator options.

Enumerator
kTextSeparatorUnknown 

Unknown text separator.

kTextSeparatorTabulation 

Text Separator tabulation.

kTextSeparatorComma 

Text Separator comma: ... , ...

kTextSeparatorSemiColumn 

Text Separator semi column: ... ; ...

Variable Documentation

◆ EwApISoftType

◆ EwAppNotify

◆ EwBooleanFiltersValue

◆ EwDockingPaneDirection

◆ EwDockingPaneStandard

◆ EwEnvironmentNotify

◆ EwErrorCode

◆ EwIconIndex

◆ EwNumberWireAction

◆ EwProjecManagerDialogNotify

◆ EwProjectNotify

◆ EwRibbonButtonSize

◆ EwRibbonButtonStyle

◆ EwRibbonControlType

◆ EwSelectionType

◆ EwTextIdentifer

◆ EwTextSeparator



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: idl_converted/EnumDefinition.idl File 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 SP03

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.