SOLIDWORKS Electrical API: idl_converted/EwAPI.idl Source File - 2025

> SOLIDWORKS Electrical API: idl_converted/EwAPI.idl Source File

Welcome

Getting Started

SOLIDWORKS API Help

SOLIDWORKS Electrical API Help

SOLIDWORKS PDM Professional API Help

PDM Pro API Web Service

FeatureWorks API Help

SOLIDWORKS Costing API Help

SOLIDWORKS Document Manager API Help

SOLIDWORKS Inspection API Help

SOLIDWORKS Routing API Help

SOLIDWORKS Simulation API Help

SOLIDWORKS Sustainability API Help

SOLIDWORKS Toolbox API Help

SOLIDWORKS Utilities API Help

SOLIDWORKS Visualize API Help

eDrawings API Help

DraftSight API Help

Lisp Programming Basics

Lisp Functions Overview

Lisp Functions Reference

Visual Lisp Compatible Functions

SOLIDWORKS Electrical API 2025.0.0

Electrical API

idl_converted

Go to the documentation of this file.

#pragma once
 
#if (__midl >= 501)
midl_pragma warning(disable:2111) /* Disable warning MIDL2111 regarding identifier lengths exceeding 31 chars. */
#endif
 
// EwAPI.idl : IDL source for EwAPI
//
 
// This file will be processed by the MIDL tool to
// produce the type library (EwAPI.tlb) and marshalling code.
import "EnumDefinition.idl";
import "EwClassificationObjects.idl";
import "EwCableObjects.idl";
import "EwManufacturerPartObjects.idl";
import "EwProjectObjects.idl";
import "EwSymbolObjects.idl";
import "EwTitleBlockObjects.idl";
import "EwLibraryObjects.idl";
import "EwTerminalObjects.idl";
import "EwServerObjects.idl";
import "EwApplicationObjects.idl";
import "EwApplicationRibbon.idl";
import "EwDialogMacroSelector.idl";
import "EwApplicationDockingPane.idl";
import "EwUiCommonResourceText.idl";
import "EwDocumentObjects.idl";
import "EwApplicationCaptionBarObjects.idl";
import "EwApplicationMenu.idl";
import "EwProjectFileConfigurationObjects.idl";
import "EwESX3DExperienceObjects.idl";
import "EwProjectFunctionObjects.idl";
import "EwCircuitTypeObjects.idl";
 
/************************************************************************/
/*                            INTERFACES                                */
/************************************************************************/
 
[
    object,
    uuid(5FC8EA1F-028E-4C83-84D0-033DDBE69F33),
    dual,
    nonextensible,
    pointer_default(unique)
]
interface IEwArchiveEnvironmentX : IDispatch
{
    EwErrorCode setArchivePath (BSTR strArchivePath);
 
    BSTR getArchivePath (EwErrorCode * errorCode);
 
    EwErrorCode setTimeStamp (EwTimeStamp eTimeStamp);
 
    EwTimeStamp getTimeStamp (EwErrorCode* errorCode);
 
    EwErrorCode setArchiveMode (EwArchiveMode eArchiveMode);
 
    EwArchiveMode getArchiveMode (EwErrorCode* errorCode);
 
    EwErrorCode setDate (DATE archiveDate);
 
    DATE getDate (EwErrorCode* errorCode);
 
    EwErrorCode archive ();
 
    EwErrorCode setLibraries (VARIANT vLibrariesArray);
 
    VARIANT getLibraries (EwErrorCode* errorCode);
 
    VARIANT_BOOL getArchiveProject (EwErrorCode* errorCode);
 
    EwErrorCode setArchiveProject (VARIANT_BOOL bArchiveProject);
 
    BSTR getLastArchiveError (EwErrorCode * errorCode);
 
};
 
[
    object,
    uuid(F29DB845-91B8-4469-B828-46A8D0396BA3),
    dual,
    oleautomation,
    nonextensible,
    helpstring("IEwEnvironmentX Interface"),
    pointer_default(unique)
]
interface IEwEnvironmentX : IDispatch {
 
    EwErrorCode setWorkingFolder (BSTR strFolderPath);
 
    EwErrorCode create (BSTR strFolderPath,  VARIANT_BOOL bAutoConnect);
 
    EwErrorCode connect ();
 
    void disconnect ();
 
    IEwManufacturerPartManagerX getEwManufacturerPartManager (EwErrorCode* errorCode);
 
    IEwCableReferenceManagerX getEwCableReferenceManager (EwErrorCode* errorCode);
 
    EwErrorCode archive (BSTR strArchivePath,  VARIANT_BOOL bDelete);
 
    EwErrorCode unarchive (BSTR strArchivePath,  BSTR strOutputFolderPath);
 
    EwErrorCode setDebugInfoType (EwLogOutputType eLogOutputType);
 
    EwErrorCode deleteWorkingDirectory ();
 
    IEwTitleBlockManagerX getEwTitleBlockManager (EwErrorCode* errorCode);
 
    BSTR getSOLIDWORKSFolderPath ();
 
    IEwLibraryManagerX getEwLibraryManager (EwErrorCode* errorCode);
 
    IEwSymbolManagerX getEwSymbolManager (EwErrorCode* errorCode);
 
    BSTR getCreoFolderPath (EwErrorCode* errorCode);
 
    BSTR getWorkingFolder (EwErrorCode* errorCode);
 
    VARIANT_BOOL getCopy3DParts (EwErrorCode* errorCode);
 
    BSTR getCreoTemplateFolderPath ();
 
    BSTR getFolderPath (EwEnvironmentFolderPathValue eEnvironmentFolderPathValue,  EwErrorCode* errorCode);
 
    IEwProjectManagerX getEwProjectManager (EwErrorCode* errorCode);
 
    BSTR getVersion ();
 
    EwErrorCode unarchiveEnvironment (BSTR* strArchivePath);
 
    EwErrorCode setHostname (BSTR strHostname);
 
    BSTR getHostname (EwErrorCode* errorCode);
 
    EwErrorCode setUserID (BSTR strUserID);
 
    BSTR getUserID (EwErrorCode* errorCode);
 
    EwErrorCode setPassword (BSTR strPassword);
 
    BSTR getPassword (EwErrorCode* errorCode);
 
    IEwProjectManagerX getEwMacroManager (EwErrorCode* errorCode);
 
    IEwClassificationManagerX getEwClassificationManager (EwErrorCode* errorCode);
 
    IEwArchiveEnvironmentX getEwArchiveEnvironment (EwErrorCode* errorCode);
 
    IEwWireTerminationTypeManagerX getEwWireTerminationTypeManager (EwErrorCode* errorCode);
 
    IEwTerminalTypeManagerX getEwTerminalTypeManager (EwErrorCode* errorCode);
 
    BSTR getXMLConfigFolder (EwXMLConfigFolderType eXMLConfigFolderType,  EwErrorCode* errorCode);
 
    BSTR getLogFilePath (EwErrorCode* errorCode);
 
    IEwEXCELImportLibraryX getEwEXCELLibraryImport (EwErrorCode* errorCode);
 
    BSTR getCircuitTypeFromKeyCode (const BSTR strKeyCode,  EwErrorCode* errorCode);
 
    IEwCircuitTypeManagerX getEwCircuitTypeManagerX (EwErrorCode* errorCode);
 
};
 
[
    object,
    uuid(7D65CD4F-DBB9-4C7F-A36D-C493FCBCEA0B),
    dual,
    oleautomation,
    nonextensible,
    helpstring("IEwApplicationSettingsX Interface"),
    pointer_default(unique)
]
interface IEwApplicationSettingsX : IDispatch {
 
    VARIANT getLanguageArray (EwErrorCode* errorCode);
 
    VARIANT getValue (EwApplicationSettingsValue eApplicationSettingsValues,  EwErrorCode* errorCode);
 
    EwErrorCode setValue (EwApplicationSettingsValue eApplicationSettingsValues,  VARIANT vValue);
 
    EwErrorCode save ();
 
};
 
[
    object,
    uuid(83A173A9-B84B-4BA3-9A44-8F8C9E11CEC3),
    dual,
    oleautomation,
    nonextensible,
    helpstring("IEwApplicationX Interface"),
    pointer_default(unique)
]
interface IEwApplicationX : IDispatch {
 
    EwErrorCode runCommand (BSTR strCommand);
 
    IEwEnvironmentX getEwEnvironment (EwErrorCode* errorCode);
 
    IEwEnvironmentX newEwEnvironment ();
 
    IEwProjectX getEwProjectCurrent (EwErrorCode* errorCode);
 
    IEwDialogSummaryX getEwDialogSummary (EwErrorCode* errorCode);
 
    IEwDialogManufacturerPartSelectorX getEwDialogManufacturerPartSelector (EwErrorCode* errorCode);
 
    IEwDialogTaskX getEwDialogTask (EwErrorCode* errorCode);
 
    IEwRightsManagerX getEwRightsManager (EwErrorCode* errorCode);
 
    EwErrorCode openEwProjectID (LONG lID);
 
    EwErrorCode closeEwProjectID (LONG lID);
 
    IEwDialogManufacturerPartOrderingX getEwDialogManufacturerPartOrdering (EwErrorCode* errorCode);
 
    IEwDialogAlignPartsParametersSelectorX getEwDialogAlignPartsParametersSelector (EwErrorCode* errorCode);
 
    EwErrorCode importFile (BSTR strFileToImport,  BSTR strOutputPath);
 
    BSTR getApplicationVersion ();
 
    BSTR getApiDllVersion ();
 
    IEwDialogLocationSelectorX getEwDialogLocationSelector (EwErrorCode* errorCode);
 
    IEwDialogMacroSelectorX getEwDialogMacroSelector (EwErrorCode* errorCode);
 
    IEwApplicationSettingsX getEwApplicationSettings (EwErrorCode* errorCode);
 
    EwErrorCode loadRespan (BSTR strFilePath);
 
    EwErrorCode unloadRespan (BSTR strFilePath);
 
    BSTR getName ();
 
    IEwCommandManagerX getEwCommandManager (EwErrorCode* errorCode);
 
    IEwXLSBookX newEwXLSBook (EwErrorCode* errorCode);
 
    IEwDialogProgressX getEwDialogProgress (EwErrorCode* errorCode);
 
    IEwDialogResumeX getEwDialogResume (EwErrorCode* errorCode);
 
    IEwProjectX openProjectFromFilePath (BSTR strFilePath,  EwErrorCode* errorCode);
 
    VARIANT_BOOL isEwProjectOpened (long lProjectId,  EwErrorCode* errorCode);
 
    VARIANT_BOOL isEwMacroOpened (long lMacroId,  EwErrorCode* errorCode);
 
    EwErrorCode openEwMacroID (LONG lID);
 
    EwErrorCode closeEwMacroID (LONG lID);
 
    BSTR findFile (BSTR strFileName,  EwErrorCode* errorCode);
 
    BSTR getWinAppName ();
 
    IEwRibbonX getEwRibbon (EwErrorCode* errorCode);
 
    BSTR getFolderPath (EwApplicationFolderPathValue eApplicationFolderPathValue , EwErrorCode* errorCode);
 
    EwErrorCode activate ();
 
    EwApISoftType getApplicationType (EwErrorCode* errorCode);
 
    EwErrorCode getSystemInformation (BSTR strPath);
 
    EwPdmType getEwPdmType (EwErrorCode* errorCode);
 
    EwErrorCode setEwPdmType (EwPdmType ePdmType);
 
    EwErrorCode close ();
 
    IEwDialogProjectManagerX getEwDialogProjectManager (EwErrorCode* errorCode);
 
    IEwDockingPaneManagerX getEwDockingPaneManager (EwErrorCode* errorCode);
 
    IEwSaveDWGImageX newEwSaveDWGImage (EwErrorCode* errorCode);
 
    IEwCaptionBarX getEwCaptionBar (EwErrorCode* errorCode);
 
    IEwManagerDialogX getEwManagerDialogObject (EwDialogManagerType eDialogManager,  EwErrorCode* errorCode);
 
    IEwSelectorDialogX getEwSelectorDialogObject (EwDialogSelectorType eDialogSelector,  EwErrorCode* errorCode);
 
    IEwDocumentX getEwDocumentCurrent (EwErrorCode* errorCode);
 
    IEwDocumentManagerX getEwDocumentManager (EwErrorCode* errorCode);
 
    IEwMenuManagerX getEwMenuManager (EwErrorCode* errorCode);
 
    IEwESX3DExperienceX getEwESX3DExperienceX (EwErrorCode* errorCode);
 
    IDispatch getSWCEFComApplication (EwErrorCode* errorCode);
 
};
 
[
    object,
    uuid(0F5E85DA-88EF-4A63-83AF-6B11A048CD79),
    dual,
    oleautomation,
    nonextensible,
    helpstring("IEwAPIX Interface"),
    pointer_default(unique),
    hidden
]
interface IEwAPIX : IDispatch {
 
    IEwApplicationX getEwApplication (BSTR strKey,  EwErrorCode* errorCode);
 
    EwErrorCode initializeInBackground (ULONGLONG mainHwnd);
 
    EwErrorCode initializeInBackgroundWithUserRight (ULONGLONG mainHwnd,  BSTR strUserLogin ,  BSTR strUserPassword);
 
};
 
[
    object,
    uuid(899CE40B-CBBC-4018-A65C-D20836ECD11C),
    dual,
    nonextensible,
    pointer_default(unique)
]
interface IEwAddIn : IDispatch
{
    VARIANT_BOOL connectToEwAPI (LPDISPATCH ewInteropFactory);
 
    VARIANT_BOOL disconnectFromEwApi ();
 
};
 
[
    object,
    uuid(6c56f4f9-3277-4cbc-8227-f7e7df9f9bdc),
    dual,
    nonextensible,
    pointer_default(unique)
]
interface IEwAddinInternalX : IDispatch
{
};
 
[
    object,
    uuid(A8F9E04C-539F-4A1B-A38B-8219C7234C90),
    dual,
    helpstring("IInteropFactoryX Interface"),
    nonextensible,
    pointer_default(unique)
]
interface IInteropFactoryX : IDispatch
{
    IEwApplicationX getEwApplication (BSTR strKey,  EwErrorCode* errorCode);
 
    IEwAPIX getEwAPI (EwErrorCode* errorCode);
 
};
 
[
    object,
    uuid(DE35BA2A-0566-40D3-AF1D-AD79D1133B09),
    dual,
    helpstring("IEwInteropFactoryX Interface"),
    nonextensible,
    pointer_default(unique)
]
interface IEwInteropFactoryX : IInteropFactoryX 
{
}

Search 'SOLIDWORKS Electrical API: idl_converted/EwAPI.idl Source File' in the SOLIDWORKS Knowledge Base.

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/EwAPI.idl Source File
*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

Cancel

Print Topic

Select the scope of content to print:

This topic and all topics linked from this topic

Just this topic

This topic and only immediate topics under it

This selected topic and all subtopics

Cancel

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

Web Help Content Version: API Help (English only) 2025 SP2

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.