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
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
IEwDockingPaneManagerX
IEwDockingPaneX
IEwEnvironmentX
IEwInteropFactoryX
IEwLibraryManagerX
IEwLibraryX
IEwLockStringX
IEwManufacturerPartCircuitX
IEwManufacturerPartManagerX
IEwManufacturerPartTerminalX
IEwManufacturerPartX
Expand IEwObjectBaseXIEwObjectBaseX
IEwPointX
IEwProjectAutomaticArrowsX
IEwProjectBookManagerX
IEwProjectCableManagerX
IEwProjectComponentManagerX
IEwProjectComponentTerminalX
IEwProjectEntity3DManagerX
IEwProjectExcelAutomationX
IEwProjectExportDWGFilesX
IEwProjectExportPDFX
IEwProjectExportPDMX
IEwProjectExportReportX
IEwProjectFileManagerX
IEwProjectFolderManagerX
IEwProjectFunctionManagerX
IEwProjectGenerateTSDrawingX
IEwProjectHarnessManagerX
IEwProjectInputOutputManagerX
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
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
IEwAPIX Interface Reference

Use this interface to initilalize this API. More...

Inheritance diagram for IEwAPIX:
[legend]

Public Member Functions

IEwApplicationX getEwApplication (BSTR strKey, EwErrorCode *errorCode)
 Create a IEwApplicationX object from the current API. More...
 
EwErrorCode initializeInBackground (ULONGLONG mainHwnd)
 Initialize this API to use the application in background. More...
 
EwErrorCode initializeInBackgroundWithUserRight (ULONGLONG mainHwnd, BSTR strUserLogin, BSTR strUserPassword)
 Initialize this API to use the application in background. More...
 

Detailed Description

Use this interface to initilalize this API.

Since
2018 SP0

Member Function Documentation

◆ getEwApplication()

IEwApplicationX IEwAPIX::getEwApplication ( BSTR  strKey,
EwErrorCode *  errorCode 
)

Create a IEwApplicationX object from the current API.

Parameters
[in]strKeythe licence code to use API
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_INVALID_LICENSE if the licence code is not valid
  • EW_UNDEFINED_ERROR if another error occurred
Returns
An IEwApplicationX connected to the current API

◆ initializeInBackground()

EwErrorCode IEwAPIX::initializeInBackground ( ULONGLONG  mainHwnd)

Initialize this API to use the application in background.

WARNING: Do not use with the GetActiveObject to get the API.

Parameters
[in]mainHwndThe handler of the main window. Can be null.
  • EW_NO_ERROR if no error detected
  • EW_CANNOT_CONNECT_PARSER if the Parser Engine is not registered
  • EW_INVALID_OBJECT if object is already initialized
  • EW_CANNOT_INITIALIZE If the module cannot be loaded
  • EW_CANNOT_CONNECT if the connection with the collaborative server doesn't work
  • EW_INVALID_RIGHT if the login/passord are not good.
  • EW_UNDEFINED_ERROR if another error occurred

◆ initializeInBackgroundWithUserRight()

EwErrorCode IEwAPIX::initializeInBackgroundWithUserRight ( ULONGLONG  mainHwnd,
BSTR  strUserLogin,
BSTR  strUserPassword 
)

Initialize this API to use the application in background.

Since
2019 SP2 if feature protection (user rights management) is active use the two next parameters. WARNING: Do not use with the GetActiveObject to get the API.
Parameters
[in]mainHwndThe handler of the main window. Can be null.
[in]strUserLoginThe user login name. Default value Empty.
[in]strUserPasswordThe password login. Default value Empty.
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_CANNOT_CONNECT_PARSER if the Parser Engine is not registered
  • EW_INVALID_OBJECT if object is already initialized
  • EW_CANNOT_INITIALIZE If the module cannot be loaded
  • EW_CANNOT_CONNECT if the connection with the collaborative server doesn't work
  • EW_INVALID_RIGHT if the login/passord are not good.
  • 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: IEwAPIX 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.26