Hide Table of Contents
SOLIDWORKS Electrical API 2025.0.0
Electrical API
EwClassificationObjects.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
16[
17 object,
18 uuid(DAE1E577-A5CE-4E4C-9515-58C4CB548CFB),
19 dual,
20 nonextensible,
21 helpstring("IEwClassX Interface"),
22 pointer_default(unique)
23]
24interface IEwClassX : IEwEnvironmentObjectX
25{
29 LONG getID ();
30
31
41 EwErrorCode setParentID (LONG lID);
42
43
52 LONG getParentID (EwErrorCode* errorCode);
53
54
63 LONG getClassificationID (EwErrorCode* errorCode);
64
65
74 LONG getClassID (EwErrorCode* errorCode);
75
76
85 EwErrorCode set3DPartName (BSTR str3DPartName);
86
87
96 BSTR get3DPartName (EwErrorCode* errorCode);
97
98
108 EwErrorCode set2DFootprintSymbolName (BSTR str2DFootprintSymbolName);
109
110
119 BSTR get2DFootprintSymbolName (EwErrorCode* errorCode);
120
121
130 EwErrorCode set2DConnectionLabelSymbolName (BSTR str2DConnectionLabelSymbolName);
131
132
141 BSTR get2DConnectionLabelSymbolName (EwErrorCode* errorCode);
142
143
152 EwErrorCode setUserDataFile (BSTR strDataFileName);
153
154
163 BSTR getUserDataFile (EwErrorCode* errorCode);
164
165
175 EwErrorCode setClassID (EwClassificationType ewClassificationType);
176
177
186 EwClassComponentType getComponentType (EwErrorCode* errorCode);
187
188
197 EwErrorCode setComponentType (EwClassComponentType ewClassComponentType);
198
199
211 IEwClassX duplicate (EwErrorCode* errorCode);
212
213
227 BSTR getDescription (BSTR strLanguage, EwErrorCode* errorCode);
228
229
244 EwErrorCode setDescription (BSTR strLanguage, BSTR strDescription);
245
246};
247
252[
253 object,
254 uuid(BA2E432E-1AFA-4401-A0BE-4E488D1F8C7E),
255 dual,
256 nonextensible,
257 helpstring("IEwClassificationX Interface"),
258 pointer_default(unique)
259]
260interface IEwClassificationX : IEwObjectX
261{
262 /*
263 * Deprecated use IEwClassificationX getID() interface .
264 * Get the ID of the object. -1 if the object is invalid.
265 * \since 2021 SP0
266 * \param[out] errorCode EwErrorCode enum type, can be:
267 * \li EW_NO_ERROR if no error detected.
268 * \li EW_UNDEFINED_ERROR if an error occurred.
269 * \return ID of current object.
270 */
271 LONG getID (EwErrorCode* errorCode);
272
273
282 LONG getEwClassCount (EwErrorCode* errorCode);
283
284
293 EwClassificationType getClassificationType (EwErrorCode* errorCode);
294
295
305 IEwClassX findEwClassByID (LONG lClassId, EwErrorCode* errorCode);
306
307
316 VARIANT getEwClassArray (EwErrorCode* errorCode);
317
318
327 IEwClassX newEwClass (EwErrorCode* errorCode);
328
329
338 EwErrorCode set3DPartName (BSTR str3DPartName);
339
340
349 BSTR get3DPartName (EwErrorCode* errorCode);
350
351
360 EwErrorCode set2DFootprintSymbolName (BSTR str2DFootprintSymbolName);
361
362
371 BSTR get2DFootprintSymbolName (EwErrorCode* errorCode);
372
373
382 EwErrorCode set2DConnectionLabelSymbolName (BSTR str2DConnectionLabelSymbolName);
383
384
393 BSTR get2DConnectionLabelSymbolName (EwErrorCode* errorCode);
394
395
408 EwClassificationType getType (EwErrorCode* errorCode);
409
410
421 EwErrorCode moveClass (long lClassId, long lClassIdParent);
422
423
424};
425
430[
431 object,
432 uuid(7E6882FA-9A8C-46A1-AB4E-BAF9484EE7FB),
433 dual,
434 nonextensible,
435 helpstring("IEwClassificationManagerX Interface"),
436 pointer_default(unique)
437]
438interface IEwClassificationManagerX : IDispatch
439{
449 IEwClassificationX getEwClassification (EwClassificationType eClassificationType, EwErrorCode* errorCode);
450
451
460 IEwClassX newEwClass (EwErrorCode* errorCode);
461
462
471 VARIANT getEwClassArray (EwErrorCode* errorCode);
472
473
483 IEwClassX findEwClassByID (long lID, EwErrorCode* errorCode);
484
485
495 IEwClassX getEwClassAt (long lIndex, EwErrorCode* errorCode);
496
497
498
507 long getEwClassCount (EwErrorCode* errorCode);
508
509};
EwErrorCode
EwErrorCode
All errors codes for this API.
Definition: EnumDefinition.idl:24
EwClassificationType
EwClassificationType
Classification for components, symbols and manufacturer parts kComponentType 0->3 kTitleBlockType 3...
Definition: EwEnumeration.idl:600
EwClassComponentType
EwClassComponentType
All the class component types.
Definition: EwEnumeration.idl:1134
IEwClassX
Use this interface to manage an EwClassX object.
Definition: EwClassificationObjects.idl:25
IEwClassX::getClassID
LONG getClassID(EwErrorCode *errorCode)
Return the class node Id, unique within the classification.
IEwClassX::getDescription
BSTR getDescription(BSTR strLanguage, EwErrorCode *errorCode)
Get the description associated to the object.
IEwClassX::getParentID
LONG getParentID(EwErrorCode *errorCode)
Return the ID of the parent of the class.
IEwClassX::getID
LONG getID()
IEwClassX::duplicate
IEwClassX duplicate(EwErrorCode *errorCode)
Duplicate current class.
IEwClassX::get2DConnectionLabelSymbolName
BSTR get2DConnectionLabelSymbolName(EwErrorCode *errorCode)
Get the default connection label symbol used if none is associated to a manufacturer part.
IEwClassX::get3DPartName
BSTR get3DPartName(EwErrorCode *errorCode)
Get the default 3D part used if none is associated to a manufacturer part.
IEwClassX::set2DConnectionLabelSymbolName
EwErrorCode set2DConnectionLabelSymbolName(BSTR str2DConnectionLabelSymbolName)
Set the default connection label symbol to use when inserting a connection label.
IEwClassX::setUserDataFile
EwErrorCode setUserDataFile(BSTR strDataFileName)
Set User Data File of node.
IEwClassX::setComponentType
EwErrorCode setComponentType(EwClassComponentType ewClassComponentType)
Set Component Type of current node in classification.
IEwClassX::setParentID
EwErrorCode setParentID(LONG lID)
Set the value of parent ID.
IEwClassX::setDescription
EwErrorCode setDescription(BSTR strLanguage, BSTR strDescription)
Set the description associated to the object.
IEwClassX::getComponentType
EwClassComponentType getComponentType(EwErrorCode *errorCode)
Get Component Type of current node in classification.
IEwClassX::setClassID
EwErrorCode setClassID(EwClassificationType ewClassificationType)
Set class id of current node in classification.
IEwClassX::getClassificationID
LONG getClassificationID(EwErrorCode *errorCode)
Return classification ID.
IEwClassX::getUserDataFile
BSTR getUserDataFile(EwErrorCode *errorCode)
Get User Data File of node.
IEwClassX::set2DFootprintSymbolName
EwErrorCode set2DFootprintSymbolName(BSTR str2DFootprintSymbolName)
Set the default 2D footprint symbol to use if none is associated to a manufacturer part.
IEwClassX::get2DFootprintSymbolName
BSTR get2DFootprintSymbolName(EwErrorCode *errorCode)
Get the default 2D footprint symbol used if none is associated to a manufacturer part.
IEwClassX::set3DPartName
EwErrorCode set3DPartName(BSTR str3DPartName)
Set the default 3D part to use when inserting a 3D part.
IEwClassificationManagerX
Use this interface to manage EwClassificationX objects.
Definition: EwClassificationObjects.idl:439
IEwClassificationManagerX::newEwClass
IEwClassX newEwClass(EwErrorCode *errorCode)
Create a new node in curent classification.
IEwClassificationManagerX::getEwClassCount
long getEwClassCount(EwErrorCode *errorCode)
Get number of nodes in all classification.
IEwClassificationManagerX::getEwClassification
IEwClassificationX getEwClassification(EwClassificationType eClassificationType, EwErrorCode *errorCode)
Get an interface of classificationX from classification type.
IEwClassificationManagerX::findEwClassByID
IEwClassX findEwClassByID(long lID, EwErrorCode *errorCode)
Get node find by id in current classification.
IEwClassificationManagerX::getEwClassAt
IEwClassX getEwClassAt(long lIndex, EwErrorCode *errorCode)
Get node find at specific position in current classification.
IEwClassificationManagerX::getEwClassArray
VARIANT getEwClassArray(EwErrorCode *errorCode)
Get array of all nodes found in current classification.
IEwClassificationX
Use this interface to manage an IEwClassificationX object.
Definition: EwClassificationObjects.idl:261
IEwClassificationX::get2DConnectionLabelSymbolName
BSTR get2DConnectionLabelSymbolName(EwErrorCode *errorCode)
Get a classification 2D Connection Label SymbolName.
IEwClassificationX::findEwClassByID
IEwClassX findEwClassByID(LONG lClassId, EwErrorCode *errorCode)
Get EwClassX find by id in current classification.
IEwClassificationX::getID
LONG getID(EwErrorCode *errorCode)
IEwClassificationX::set2DConnectionLabelSymbolName
EwErrorCode set2DConnectionLabelSymbolName(BSTR str2DConnectionLabelSymbolName)
Set a classification 2D Connection Label SymbolName.
IEwClassificationX::getEwClassCount
LONG getEwClassCount(EwErrorCode *errorCode)
Get number of class in this classification.
IEwClassificationX::set2DFootprintSymbolName
EwErrorCode set2DFootprintSymbolName(BSTR str2DFootprintSymbolName)
Set a classification 2D Footprint SymbolName.
IEwClassificationX::getClassificationType
EwClassificationType getClassificationType(EwErrorCode *errorCode)
Get classification's type.
IEwClassificationX::getEwClassArray
VARIANT getEwClassArray(EwErrorCode *errorCode)
Get the classification's class array.
IEwClassificationX::get3DPartName
BSTR get3DPartName(EwErrorCode *errorCode)
Get a classification 3d part name.
IEwClassificationX::getType
EwClassificationType getType(EwErrorCode *errorCode)
Get an EwClassificationType enumeration type.
IEwClassificationX::moveClass
EwErrorCode moveClass(long lClassId, long lClassIdParent)
Move a class in the classification (change parent).
IEwClassificationX::set3DPartName
EwErrorCode set3DPartName(BSTR str3DPartName)
Set a classification 3d part name.
IEwClassificationX::get2DFootprintSymbolName
BSTR get2DFootprintSymbolName(EwErrorCode *errorCode)
Get a classification 2D Footprint SymbolName.
IEwClassificationX::newEwClass
IEwClassX newEwClass(EwErrorCode *errorCode)
Create a new node in electrical classification.
IEwEnvironmentObjectX
This interface is a generic interface for environment object methods.
Definition: EwObjectBaseObjects.idl:339
IEwObjectX
This interface is a generic interface for standard object methods.
Definition: EwObjectBaseObjects.idl:97
Generated by doxygen 1.9.4


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

0.20.46