Hide Table of Contents
SOLIDWORKS Electrical API  2022.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 
7 import "oaidl.idl";
8 import "ocidl.idl";
9 
10 import "EnumDefinition.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 ]
29 interface IEwLibraryX : IDispatch{
30 
38  EwErrorCode setName (BSTR strName);
39 
40 
48  BSTR getName (EwErrorCode* errorCode);
49 
50 
51 
52 
62  EwErrorCode setDescription (BSTR strLgCode, BSTR strVal);
63 
64 
74  BSTR getDescription (BSTR strLgCode, EwErrorCode* errorCode);
75 
76 
84  DATE getModificationDate (EwErrorCode* errorCode);
85 
86 
94  DATE getCreationDate (EwErrorCode* errorCode);
95 
96 
104  EwCreatorType getEwCreator (EwErrorCode* errorCode);
105 
106 
114  EwErrorCode setVersionNumber (LONG lValueId);
115 
116 
124  LONG getVersionNumber (EwErrorCode* errorCode);
125 
126 
127  /*
128  * Insert a library inside the current environment
129  * \return EwErrorCode enum type, can be:
130  * \li EW_NO_ERROR if no error detected
131  * \li EW_UNDEFINED_ERROR if another error occurred
132  * \li EW_INSERTION_FAILED if the insertion failed
133  * \li EW_OBJECT_ALREADY_INSERTED if this object is already exists
134  */
135  EwErrorCode insert ();
136 
137 
138  /*
139  * remove a library from the current environment
140  * \return EwErrorCode enum type, can be:
141  * \li EW_NO_ERROR if no error detected
142  * \li EW_UNDEFINED_ERROR if another error occurred
143  */
144  EwErrorCode remove ();
145 
146 
147  /*
148  * update a library inside the current environment
149  * \return EwErrorCode enum type, can be:
150  * \li EW_NO_ERROR if no error detected
151  * \li EW_UNDEFINED_ERROR if another error occurred
152  */
153  EwErrorCode update ();
154 
155 
163  EwErrorCode setEwLibContentType (EwLibContentType eLibContentType);
164 
165 
173  EwLibContentType getEwLibContentType (EwErrorCode* errorCode);
174 
175 
179  long getId ();
180 
181 
190  BSTR getModifiedBy (EwErrorCode* eErrorCode);
191 
192 
205  EwErrorCode setTranslatedData (LONG nUserDataNumber, BSTR strLanguage, BSTR strValue);
206 
207 
220  BSTR getTranslatedData (LONG nUserDataNumber, BSTR strLanguage, EwErrorCode* errorCode);
221 
222 
231  BSTR getCreatedBy (EwErrorCode* eErrorCode);
232 
233 
234 };
235 
240 [
241  object,
242  uuid(7817B1F0-12A0-4539-AB67-DD43A2F290D3),
243  dual,
244  oleautomation,
245  nonextensible,
246  helpstring("IEwLibraryManagerX Interface"),
247  pointer_default(unique)
248 ]
249 interface IEwLibraryManagerX : IDispatch
250 {
255  IEwLibraryX newEwLibrary ();
256 
257 
261  LONG getCount ();
262 
263 
270  VARIANT getEwLibraryArray (EwErrorCode* errorCode);
271 
272 
282  IEwLibraryX findEwLibraryById (long lId,EwErrorCode* errorCode);
283 
284 }
IEwLibraryX
Use this interface to manage an EwLibraryX object.
Definition: EwLibraryObjects.idl:29
IEwLibraryX::getCreationDate
DATE getCreationDate(EwErrorCode *errorCode)
return a creation date of current library
IEwLibraryManagerX
Use this interface to manage EwLibraryX objects.
Definition: EwLibraryObjects.idl:250
IEwLibraryX::getTranslatedData
BSTR getTranslatedData(LONG nUserDataNumber, BSTR strLanguage, EwErrorCode *errorCode)
Get the value of a translated text.
IEwLibraryX::setVersionNumber
EwErrorCode setVersionNumber(LONG lValueId)
set a version Number of current Library
IEwLibraryManagerX::newEwLibrary
IEwLibraryX newEwLibrary()
Create a IEwLibraryX object from the associated environnement.
EwErrorCode
EwErrorCode
All errors codes for this API.
Definition: EnumDefinition.idl:21
IEwLibraryManagerX::getEwLibraryArray
VARIANT getEwLibraryArray(EwErrorCode *errorCode)
return the array of IEwLibraryX of associated environment
IEwLibraryX::getName
BSTR getName(EwErrorCode *errorCode)
return name of current Library
EwLibContentType
EwLibContentType
All library content types.
Definition: EwEnumeration.idl:284
IEwLibraryManagerX::findEwLibraryById
IEwLibraryX findEwLibraryById(long lId, EwErrorCode *errorCode)
return IEwLibraryX by id
IEwLibraryX::getModificationDate
DATE getModificationDate(EwErrorCode *errorCode)
return a modification date of current library
IEwLibraryX::getDescription
BSTR getDescription(BSTR strLgCode, EwErrorCode *errorCode)
return a description of language parameter
IEwLibraryX::update
EwErrorCode update()
IEwLibraryX::getVersionNumber
LONG getVersionNumber(EwErrorCode *errorCode)
get a version of current Library
IEwLibraryX::getEwCreator
EwCreatorType getEwCreator(EwErrorCode *errorCode)
return a creator of current Library
IEwLibraryX::getModifiedBy
BSTR getModifiedBy(EwErrorCode *eErrorCode)
Get the last user name that modified the current object.
IEwLibraryX::getEwLibContentType
EwLibContentType getEwLibContentType(EwErrorCode *errorCode)
return content type of current Library
IEwLibraryX::getId
long getId()
IEwLibraryX::setTranslatedData
EwErrorCode setTranslatedData(LONG nUserDataNumber, BSTR strLanguage, BSTR strValue)
Set the value of a translated text.
IEwLibraryX::setEwLibContentType
EwErrorCode setEwLibContentType(EwLibContentType eLibContentType)
set a content type of current Library
IEwLibraryX::insert
EwErrorCode insert()
EwCreatorType
EwCreatorType
All creator type.
Definition: EwEnumeration.idl:260
IEwLibraryX::setName
EwErrorCode setName(BSTR strName)
set the name of library
IEwLibraryX::getCreatedBy
BSTR getCreatedBy(EwErrorCode *eErrorCode)
Get the user name that created the current object.
IEwLibraryX::setDescription
EwErrorCode setDescription(BSTR strLgCode, BSTR strVal)
set a description of Library
Generated on Wed Aug 18 2021 10:34:10 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: 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) 2022 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