Hide Table of Contents
SOLIDWORKS Electrical API  2022.0.0
Electrical API
EwSymbolObjects.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 import "EwClassificationObjects.idl";
12 
13 /************************************************************************/
14 /* In his file, all SYMBOL object */
15 /************************************************************************/
16 
17 /************************************************************************/
18 /* INTERFACES */
19 /************************************************************************/
20 
25 [
26  object,
27  uuid(97D8E9CC-9C15-4DEF-AC7C-7BB7ED11164A),
28  dual,
29  oleautomation,
30  nonextensible,
31  helpstring("IEwSymbolPointX Interface"),
32  pointer_default(unique)
33 ]
34 interface IEwSymbolPointX : IDispatch{
35 
36 
37 
45  EwErrorCode getNumber (LONG* lNo);
46 
47 
56 
57 
66 
67 
76 
77 
86 
87 
95  DOUBLE getXPos (EwErrorCode* errorCode);
96 
97 
105  EwErrorCode setXPos (DOUBLE dXValue);
106 
107 
115  DOUBLE getYPos (EwErrorCode* errorCode);
116 
117 
125  EwErrorCode setYPos (DOUBLE dYValue);
126 
127 
135  DOUBLE getAngle (EwErrorCode* errorCode);
136 
137 
145  EwErrorCode setAngle (DOUBLE dAngle);
146 
147 
157 
158 
167  EwErrorCode setTerminationTypeCode (BSTR strTerminationTypeCode);
168 
169 };
170 
175 [
176  object,
177  uuid(960C29C7-51FA-452E-865E-59F7C0669A7A),
178  dual,
179  oleautomation,
180  nonextensible,
181  helpstring("IEwSymbolCircuitX Interface"),
182  pointer_default(unique)
183 ]
184 interface IEwSymbolCircuitX : IDispatch
185 {
186 
187 
195  EwErrorCode getNumber (LONG* lNo);
196 
197 
206 
207 
216 
217 
225  EwErrorCode getType (BSTR* strKeyCode);
226 
227 
236  EwErrorCode setType (BSTR strKeyCode);
237 
238 };
239 
240 
245 [
246  object,
247  uuid(02C2A32C-B421-42C8-9A7B-48BCF979D50C),
248  dual,
249  oleautomation,
250  nonextensible,
251  helpstring("IEwSymbolFiltersX Interface"),
252  pointer_default(unique)
253 ]
254 interface IEwSymbolFiltersX : IDispatch{
255 
260  LONG getClassNodeID ();
261 
262 
267  void setClassNodeID (LONG lNodeID);
268 
269 
275 
276 
281  void setEwSymbolType (EwSymbolType eSymbolTypes);
282 
283 
288  BSTR getSymbolName ();
289 
290 
295  void setSymbolName (BSTR strName);
296 
297 
306  BSTR getDescription (BSTR lgCode, EwErrorCode* errorCode);
307 
308 
317  EwErrorCode setDescription (BSTR lgCode, BSTR val);
318 
319 
325 
326 
331  void setEwMeasurementType (EwMeasurementType eMeasurementTypes);
332 
333 
338  BSTR getLibraryCode ();
339 
340 
345  void setLibraryCode (BSTR strLibraryCode);
346 
347 
353 
354 
359  void setManufacturer (BSTR strManufacturer);
360 
361 
366  BSTR getReference ();
367 
368 
373  void setReference (BSTR strReference);
374 
375 
381 
382 
387  void setModificationDateFrom (DATE modificationDateFrom);
388 
389 
395 
396 
401  void setModificationDateTo (DATE modificationDateTo);
402 
403 
409 
410 
415  void setCreationDateFrom (DATE creationDateFrom);
416 
417 
423 
424 
429  void setCreationDateTo (DATE creationDateTo);
430 
431 
437 
438 
443  void setEwSymbolCircuitCount (LONG lNbCircuit);
444 
445 
451 
452 
457  void setEwSymbolPointCount (LONG lConnectionPoint);
458 
459 
464  BSTR getRootMark ();
465 
466 
471  void setRootMark (BSTR strRootMark);
472 
473 
479 
480 
485  void setAssociatedMacro (BSTR strAssociatedMacro);
486 
487 
493 
494 
499  void setEwSymbolCrossRefType (EwSymbolCrossRefType eSymbolCrossRefTypes);
500 
501 
507 
508 
513  void setDisplayEwSymbolPoint (EwBooleanFiltersValue eBooleanFiltersValues);
514 
515 
521 
522 
527  void setDoNotRotateAttributes (EwBooleanFiltersValue eBooleanFiltersValue);
528 
529 
539  EwErrorCode getEwSymbolArray (VARIANT* vArray);
540 
541 
547 
548 
553  void setTerminalStripDrawingSymbol (BSTR strTerminalStripDrawingSymbol);
554 
555 
556 };
557 
562 [
563  object,
564  uuid(90C1D0BC-FDC7-4410-BB37-2A86CA6CA1EC),
565  dual,
566  oleautomation,
567  nonextensible,
568  helpstring("IEwSymbolX Interface"),
569  pointer_default(unique)
570 ]
571 interface IEwSymbolX : IDispatch{
572 
573 
574 
575 
584  IEwSymbolCircuitX addEwSymbolCircuit (BSTR strCircuitCode, EwErrorCode* errorCode);
585 
586 
596 
597 
603 
604 
615 
616 
626  BSTR getDescription (BSTR lgCode, EwErrorCode* errorCode);
627 
628 
638  EwErrorCode setDescription (BSTR lgCode, BSTR strValue);
639 
640 
648  LONG getID (EwErrorCode* errorCode);
649 
650 
658  BSTR getReference (EwErrorCode* errorCode);
659 
660 
668  EwErrorCode setReference (BSTR strReference);
669 
670 
678  BSTR getManufacturer (EwErrorCode* errorCode);
679 
680 
688  EwErrorCode setManufacturer (BSTR strManufacturer);
689 
690 
698  LONG getClassNodeID (EwErrorCode* errorCode);
699 
700 
708  EwErrorCode setClassNodeID (LONG lNodeId);
709 
710 
718  BSTR getLibraryCode (EwErrorCode* errorCode);
719 
720 
728  EwErrorCode setLibraryCode (BSTR strLibraryCode);
729 
730 
738  DATE getModificationDate (EwErrorCode* errorCode);
739 
740 
748  DATE getCreationDate (EwErrorCode* errorCode);
749 
750 
759 
760 
768  BSTR getRootMark (EwErrorCode* errorCode);
769 
770 
778  EwErrorCode setRootMark (BSTR strRootMark);
779 
780 
788  BSTR getName (EwErrorCode* errorCode);
789 
790 
799  EwErrorCode setName (BSTR strSymbolName);
800 
801 
810 
811 
820 
821 
830 
831 
840 
841 
850 
851 
860 
861 
869  BSTR getAssociatedMacro (EwErrorCode* errorCode);
870 
871 
879  EwErrorCode setAssociatedMacro (BSTR strAssociatedMacro);
880 
881 
889  BSTR getStandard (EwErrorCode* errorCode);
890 
891 
899  EwErrorCode setStandard (BSTR strStandard);
900 
901 
909  VARIANT_BOOL isConnectionPointVisible (EwErrorCode* errorCode);
910 
911 
919  EwErrorCode showConnectionPoint (VARIANT_BOOL bVisible);
920 
921 
929  EwErrorCode getDoNotRotateAttributes (VARIANT_BOOL* bRotate);
930 
931 
939  EwErrorCode setDoNotRotateAttributes (VARIANT_BOOL bRotate);
940 
941 
954 
955 
965 
966 
973  EwErrorCode remove ();
974 
975 
989  EwErrorCode insertFromDwg (BSTR strDwgFilePath);
990 
991 
999  BOOL isAlreadyOpened (EwErrorCode* errorCode);
1000 
1001 
1010 
1011 
1021 
1022 
1028 
1029 
1040 
1041 
1050  BSTR getModifiedBy (EwErrorCode* eErrorCode);
1051 
1052 
1061  BSTR getCreatedBy (EwErrorCode* eErrorCode);
1062 
1063 
1074  IEwClassificationX getClassification (EwErrorCode* errorCode);
1075 
1076 };
1077 
1082 [
1083  object,
1084  uuid(D4CAA186-3BD6-462A-A3DC-E1DB39B7941E),
1085  dual,
1086  oleautomation,
1087  nonextensible,
1088  helpstring("IEwSymbolManagerX Interface"),
1089  pointer_default(unique)
1090 ]
1091 interface IEwSymbolManagerX : IDispatch
1092 {
1098 
1099 
1103  LONG getCount ();
1104 
1105 
1109  VARIANT getEwSymbolArray (EwErrorCode* errorCode);
1110 
1111 
1117 
1118 
1129  IEwSymbolX at (int iIndex, EwErrorCode* errorCode);
1130 
1131 
1144  IEwSymbolX findEwSymbolXById (long lId, EwErrorCode* errorCode);
1145 
1146 
1159  IEwSymbolX findEwSymbolXByName (BSTR strName, EwErrorCode* errorCode);
1160 
1161 }
EwErrorCode getEwSymbolArray(VARIANT *vArray)
Return Array of Symbol according to filter.
BSTR getCreatedBy(EwErrorCode *eErrorCode)
Get the user name that created the current object.
void setEwSymbolCircuitCount(LONG lNbCircuit)
Set/reset the number of circuit of the filter.
void setClassNodeID(LONG lNodeID)
Set/reset the class ID of the filter.
IEwSymbolFiltersX newEwSymbolFilters()
Create a IEwSymbolFiltesrX object to get symbols af associated environment.
void setDoNotRotateAttributes(EwBooleanFiltersValue eBooleanFiltersValue)
Set the value of "do not rotate attributes" of the filter.
EwErrorCode deleteEwSymbolCircuitAt(LONG index)
Delete a circuit from the symbol.
BOOL isAlreadyOpened(EwErrorCode *errorCode)
Check if the drawing is already opened.
IEwSymbolPointX addEwSymbolPoint(EwErrorCode *errorCode)
Create and add a connection point for the symbol.
BSTR getReference()
Get the reference of the filter.
EwErrorCode setStandard(BSTR strStandard)
Set the standard of the symbol.
DATE getModificationDate(EwErrorCode *errorCode)
Get the last modification date of the symbol.
BSTR getRootMark()
Get the root mark of the filter.
EwBooleanFiltersValue getDoNotRotateAttributes()
Get the value of "do not rotate attributes" of the filter.
void setReference(BSTR strReference)
Set/reset the reference of the filter.
LONG getClassNodeID()
Get the class ID of the filter.
LONG getEwSymbolPointCount()
Count the number of connection point in the symbol.
BSTR getTerminationTypeCode(EwErrorCode *errorCode)
Get the termination type code of the connection point.
BSTR getStandard(EwErrorCode *errorCode)
Get the standard of the symbol.
EwErrorCode setAngle(DOUBLE dAngle)
Set the angle of the connection point.
IEwSymbolX newEwSymbol()
Create a IEwSymbolX object from the associated environnement.
EwErrorCode setType(BSTR strKeyCode)
Set the type of the circuit.
EwErrorCode
All errors codes for this API.
Definition: EnumDefinition.idl:21
EwErrorCode setDescription(BSTR lgCode, BSTR val)
Set/reset the description of the filter.
EwErrorCode setEwCircuitPassingType(EwCircuitPassingType ePassingType)
Set the passing type of the circuit.
LONG getClassNodeID(EwErrorCode *errorCode)
Get the classification node ID of the symbol.
EwErrorCode deleteEwSymbolPoint(LONG index)
Delete a connection point from the symbol.
EwMeasurementType
All measurement type.
Definition: EwEnumeration.idl:273
EwSymbolType getEwSymbolType()
Get the symbol type of the filter.
DATE getModificationDateTo()
Get the "modification date to" of the filter.
EwErrorCode setManufacturer(BSTR strManufacturer)
Set the manufacturer of the symbol.
BSTR getManufacturer()
Get the manufacturer of the filter.
void setSymbolName(BSTR strName)
Set/reset the symbol name of the filter.
EwPointOrientation getEwPointOrientation(EwErrorCode *errorCode)
Get the flow direction of the connection point.
void setAssociatedMacro(BSTR strAssociatedMacro)
Set/reset the associated macro of the filter.
void setCreationDateTo(DATE creationDateTo)
Set/reset the "creation date to" of the filter.
void setEwMeasurementType(EwMeasurementType eMeasurementTypes)
Set/reset the measurement of the filter.
IEwSymbolX at(int iIndex, EwErrorCode *errorCode)
Return an IEwSymbolX at a given position from the associated environment.
EwErrorCode setEwPointOrientation(EwPointOrientation ePointOrientation)
Set the flow direction of the connection point.
void setManufacturer(BSTR strManufacturer)
Set/reset the manufacturer of the filter.
EwSymbolCrossRefType getEwSymbolCrossRefType()
Get the type of cross reference of the filter.
IEwSymbolX findEwSymbolXByName(BSTR strName, EwErrorCode *errorCode)
Find an IEwSymbolX by his Name.
Use this interface to manage filter for EwSymbolX.
Definition: EwSymbolObjects.idl:254
LONG getEwSymbolCircuitNumber(EwErrorCode *errorCode)
Get the circuit number of the connection point.
EwMeasurementType getEwMeasurementType()
Get the measurement of the filter.
IEwSymbolCircuitX addEwSymbolCircuit(BSTR strCircuitCode, EwErrorCode *errorCode)
Create and add a circuit in the symbol.
IEwClassificationX getClassification(EwErrorCode *errorCode)
Get the classification of the current symbol.
EwErrorCode insert()
Insert this object inside the current environment.
BSTR getAssociatedMacro()
Get the associated macro of the filter.
BSTR getModifiedBy(EwErrorCode *eErrorCode)
Get the last user name that modified the current object.
void setModificationDateFrom(DATE modificationDateFrom)
Set/reset the modification date from of the filter.
EwErrorCode setLibraryCode(BSTR strLibraryCode)
Set the library code of the symbol.
EwErrorCode showConnectionPoint(VARIANT_BOOL bVisible)
Show connection point.
EwErrorCode setEwSymbolCircuitNumber(LONG lCircuitNo)
Set the circuit number of the connection point.
void setModificationDateTo(DATE modificationDateTo)
Set/reset the "modification date to" of the filter.
BSTR getDescription(BSTR lgCode, EwErrorCode *errorCode)
Get the description of the filter.
Use this interface to manage a circuit inside a symbol.
Definition: EwSymbolObjects.idl:185
void setDisplayEwSymbolPoint(EwBooleanFiltersValue eBooleanFiltersValues)
Set the display connection point value of the filter.
DOUBLE getAngle(EwErrorCode *errorCode)
Get the angle of the connection point.
EwErrorCode setAssociatedMacro(BSTR strAssociatedMacro)
Set the associated macro of the symbol.
VARIANT_BOOL isConnectionPointVisible(EwErrorCode *errorCode)
Check if connection point are displayed.
DATE getCreationDate(EwErrorCode *errorCode)
Get the creation date of the symbol.
EwErrorCode setEwSymbolCrossRefType(EwSymbolCrossRefType eSymbolCrossRefType)
Set the cross reference type of the symbol.
EwErrorCode setTerminationTypeCode(BSTR strTerminationTypeCode)
Set the termination type code of the connection point.
void setRootMark(BSTR strRootMark)
Set/reset the root mark of the filter.
EwErrorCode setReference(BSTR strReference)
Set the reference of the symbol.
EwSymbolType
All types of symbol.
Definition: EwEnumeration.idl:416
DATE getCreationDateFrom()
Get the "creation date from" of the filter.
BSTR getAssociatedMacro(EwErrorCode *errorCode)
Return the associated macro of the symbol.
EwErrorCode setName(BSTR strSymbolName)
Set the name of the symbol.
void setEwSymbolCrossRefType(EwSymbolCrossRefType eSymbolCrossRefTypes)
Set/reset the type of cross reference of the filter.
LONG getEwSymbolPointCount()
Get the number of connection point of the filter.
BSTR getRootMark(EwErrorCode *errorCode)
Get the root mark of the symbol.
EwErrorCode setRootMark(BSTR strRootMark)
Set the root mark of the symbol.
EwSymbolCrossRefType
All cross reference type of symbol.
Definition: EwEnumeration.idl:443
EwErrorCode getNumber(LONG *lNo)
Get the number of the circuit.
EwErrorCode insertFromDwg(BSTR strDwgFilePath)
Insert the object inside the current environment.
EwErrorCode update()
Update the object inside the current environment.
Use this interface to manage a connection point.
Definition: EwSymbolObjects.idl:34
LONG getEwSymbolCircuitCount()
Get the number of circuit of the filter.
EwErrorCode setDescription(BSTR lgCode, BSTR strValue)
Set a description of the symbol.
EwErrorCode setYPos(DOUBLE dYValue)
Set the Y coordinate of the connection point.
EwErrorCode getType(BSTR *strKeyCode)
Get the type of the circuit.
EwMeasurementType getEwMeasurementType(EwErrorCode *errorCode)
Return the measurement type of the symbol.
void setLibraryCode(BSTR strLibraryCode)
Set/reset the library code of the filter.
BSTR getTerminalStripDrawingSymbol()
Get the TerminalStrip drawing symbol of the filter.
EwErrorCode setEwMeasurementType(EwMeasurementType eMeasurementType)
Set the measurement type of the symbol.
void setEwSymbolType(EwSymbolType eSymbolTypes)
Set/reset the symbol type of the filter.
BSTR getReference(EwErrorCode *errorCode)
Get the reference of the symbol.
LONG getID(EwErrorCode *errorCode)
Get ID of the symbol.
EwErrorCode setXPos(DOUBLE dXValue)
Set the X coordinate of the connection point.
EwSymbolType getEwSymbolType(EwErrorCode *errorCode)
Get the type of the symbol.
BSTR getName(EwErrorCode *errorCode)
Get the name of the symbol.
IEwSymbolX findEwSymbolXById(long lId, EwErrorCode *errorCode)
Find an IEwSymbolX by ID.
VARIANT getEwSymbolArray(EwErrorCode *errorCode)
return the array of IEwSymbolX of associated environment
EwErrorCode getDoNotRotateAttributes(VARIANT_BOOL *bRotate)
Get value of option "Do not rotate attributes".
EwErrorCode setDoNotRotateAttributes(VARIANT_BOOL bRotate)
Set value of option "Do not rotate attributes".
BSTR getManufacturer(EwErrorCode *errorCode)
Get the manufacturer of the symbol.
EwCircuitPassingType
All passing types of symbol circuit.
Definition: EwEnumeration.idl:669
IEwSymbolPointX getEwSymbolPointAt(LONG index, EwErrorCode *errorCode)
Get a connection point inside the symbol.
void setCreationDateFrom(DATE creationDateFrom)
Set/reset the "creation date from" of the filter.
DOUBLE getXPos(EwErrorCode *errorCode)
Get the X coordinate of the connection point.
LONG getEwSymbolCircuitCount()
Count the number of circuit in this symbol.
EwErrorCode setEwSymbolType(EwSymbolType eSymbolType)
Set the type of the symbol.
EwBooleanFiltersValue getDisplayEwSymbolPoint()
Get the display connection point value of the filter.
DOUBLE getYPos(EwErrorCode *errorCode)
Get the Y coordinate of the connection point.
BSTR getSymbolName()
Get the symbol name of the filter.
Use this interface to manage a symbol.
Definition: EwSymbolObjects.idl:571
EwErrorCode getNumber(LONG *lNo)
Get the number of the connection point.
IEwSymbolCircuitX getEwSymbolCircuitAt(LONG index, EwErrorCode *errorCode)
Get a circuit inside the symbol.
void setEwSymbolPointCount(LONG lConnectionPoint)
Set/reset the number of connection point of the filter.
DATE getCreationDateTo()
Get the "creation date to" of the filter.
EwSymbolCrossRefType getEwSymbolCrossRefType(EwErrorCode *errorCode)
Return the cross reference type of the symbol.
EwCreatorType
All creator type.
Definition: EwEnumeration.idl:260
DATE getModificationDateFrom()
Get the modification date from of the filter.
BSTR getLibraryCode(EwErrorCode *errorCode)
Get the library code of the symbol.
EwBooleanFiltersValue
All value for boolean filters.
Definition: EnumDefinition.idl:83
EwCreatorType getEwCreatorType(EwErrorCode *errorCode)
Get the creator of the symbol.
Use this interface to manage EwSymbolX objects.
Definition: EwSymbolObjects.idl:1092
EwErrorCode getEwCircuitPassingType(EwCircuitPassingType *ePassingType)
Get the passing type of the circuit.
EwErrorCode setClassNodeID(LONG lNodeId)
Set the classification node ID of the symbol.
void setTerminalStripDrawingSymbol(BSTR strTerminalStripDrawingSymbol)
Set/reset the TerminalStrip drawing symbol of the filter.
BSTR getLibraryCode()
Get the library code of the filter.
BSTR getDescription(BSTR lgCode, EwErrorCode *errorCode)
Get a description of the symbol.
EwPointOrientation
Flow direction of symbol connexion point type.
Definition: EwEnumeration.idl:658


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