Hide Table of Contents
SOLIDWORKS Electrical API 2025.0.0
Electrical API
EwLibraryObjects.idl
Go to the documentation of this file.
1#pragma once
2
3#if (__midl >= 501)
4 midl_pragma warning(disable:2111) /* Disable warning MIDL2111 regarding identifier lengths exceeding 31 chars. */
5#endif
6
7import "oaidl.idl";
8import "ocidl.idl";
9
10import "EwObjectBaseObjects.idl";
11
12/************************************************************************/
13/* */
14/************************************************************************/
15
21[
22 object,
23 uuid(FB1C5D7A-5B0C-44F6-A8E7-271EBFC18627),
24 dual,
25 oleautomation,
26 nonextensible,
27 pointer_default(unique)
28]
30{
34 long getID ();
35
36
46
47
56 EwErrorCode setName (BSTR strName);
57
58
66 BSTR getName (EwErrorCode* errorCode);
67
68
78 EwErrorCode setDescription (BSTR strLgCode, BSTR strVal);
79
80
90 BSTR getDescription (BSTR strLgCode, EwErrorCode* errorCode);
91
92
101
102
110 LONG getVersionNumber (EwErrorCode* errorCode);
111
112
121
122
131
132
145
146};
147
152[
153 object,
154 uuid(7817B1F0-12A0-4539-AB67-DD43A2F290D3),
155 dual,
156 oleautomation,
157 nonextensible,
158 helpstring("IEwLibraryManagerX Interface"),
159 pointer_default(unique)
160]
161interface IEwLibraryManagerX : IDispatch
162{
168
169
173 LONG getCount ();
174
175
182 VARIANT getEwLibraryArray (EwErrorCode* errorCode);
183
184
195
196}
197
198
204[
205 object,
206 uuid(5e465b8d-cf30-402e-8cb1-a2ab10281ef8),
207 dual,
208 nonextensible,
209 pointer_default(unique)
210]
211interface IEwEXCELImportLibraryX : IDispatch
212{
223
224
236 EwErrorCode openFile (BSTR strArchivePath);
237
238
249
250
260
261
271 EwErrorCode setLogFilePath (BSTR strLogFilePath);
272
273
282 BSTR getLogFilePath (EwErrorCode* errorCode);
283
284
296
297
309
310
322
323
335
336
348
349
361
362
372
373
385
386};
EwTextSeparator
Text separator options.
Definition: EnumDefinition.idl:228
EwErrorCode
All errors codes for this API.
Definition: EnumDefinition.idl:24
EwRowFormat
Type of format of EXCEL file for importing data.
Definition: EwEnumeration.idl:1596
EwLibraryType
Type of import data.
Definition: EwEnumeration.idl:1584
EwCreatorType
All creator type.
Definition: EwEnumeration.idl:287
EwLibContentType
All library content types.
Definition: EwEnumeration.idl:312
Use this interface to import manufacturer parts or cable references from an EXCEL file populated from...
Definition: EwLibraryObjects.idl:212
EwRowFormat getRowFormat(EwErrorCode *errorCode)
Get Format used for displaying data in XLS file.
EwErrorCode importData()
Import data previously simulate in current services.
EwErrorCode openFile(BSTR strArchivePath)
Open EXCEL file containing manufacturer part of cable reference data to import.
EwTextSeparator getCircuitSeparator(EwErrorCode *errorCode)
Get separator used for listing circuits in manufacturer parts.
EwTextSeparator getTerminalSeparator(EwErrorCode *errorCode)
Get separator used for listing terminals in circuit in manufacturer part.
EwErrorCode setTerminalSeparator(EwTextSeparator eSeparator)
Set separator used for listing terminals in circuit in manufacturer part.
EwErrorCode setLogFilePath(BSTR strLogFilePath)
Set file path for log file, if file exists it will be overwrite.
BSTR getLogFilePath(EwErrorCode *errorCode)
Get file path for log file.
EwErrorCode setCableCoreSeparator(EwTextSeparator eSeparator)
Set separator used for listing cable core in cable reference.
EwErrorCode setCircuitSeparator(EwTextSeparator eSeparator)
Set separator used for listing circuits in manufactuer parts.
EwTextSeparator getCableCoreSeparator(EwErrorCode *errorCode)
Get separator used for listing cable core in cable reference.
EwErrorCode simulate()
Parse EXCEL file, verify data consistency and prepare the import.
EwErrorCode create(EwLibraryType ewLibraryType)
Create object to import manufacturer parts or cable references object according with context.
EwErrorCode setRowFormat(EwRowFormat eEwRowFormat)
Set Format used for displaying data in XLS file.
This interface is a generic interface for environment object methods.
Definition: EwObjectBaseObjects.idl:339
Use this interface to manage EwLibraryX objects.
Definition: EwLibraryObjects.idl:162
IEwLibraryX newEwLibrary()
Create a IEwLibraryX object from the associated environnement.
IEwLibraryX findEwLibraryById(long lId, EwErrorCode *errorCode)
return IEwLibraryX by id
VARIANT getEwLibraryArray(EwErrorCode *errorCode)
return the array of IEwLibraryX of associated environment
Use this interface to manage an EwLibraryX object.
Definition: EwLibraryObjects.idl:30
long getID()
IEwLibraryX duplicate(EwErrorCode *errorCode)
Duplicate current library.
LONG getVersionNumber(EwErrorCode *errorCode)
get a version of current Library
EwErrorCode setEwLibContentType(EwLibContentType eLibContentType)
set a content type of current Library
EwErrorCode setName(BSTR strName)
set the name of library
BSTR getName(EwErrorCode *errorCode)
return name of current Library
EwLibContentType getEwLibContentType(EwErrorCode *errorCode)
return content type of current Library
EwErrorCode setDescription(BSTR strLgCode, BSTR strVal)
set a description of Library
BSTR getDescription(BSTR strLgCode, EwErrorCode *errorCode)
return a description of language parameter
EwCreatorType getEwCreator(EwErrorCode *errorCode)
Deprecated use getEwCreatorType interface now.
EwErrorCode setVersionNumber(LONG lValueId)
set a version Number of current Library


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/EwLibraryObjects.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

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) 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.