Hide Table of Contents
SOLIDWORKS Electrical API  2020.0.5
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 
12 /************************************************************************/
13 /* In his file, all SYMBOL object */
14 /************************************************************************/
15 
16 /************************************************************************/
17 /* INTERFACES */
18 /************************************************************************/
19 
24 [
25  object,
26  uuid(97D8E9CC-9C15-4DEF-AC7C-7BB7ED11164A),
27  dual,
28  oleautomation,
29  nonextensible,
30  helpstring("IEwSymbolPointX Interface"),
31  pointer_default(unique)
32 ]
33 interface IEwSymbolPointX : IDispatch{
34 
35 
36 
44  EwErrorCode getNumber (LONG* lNo);
45 
46 
55 
56 
65 
66 
75 
76 
84  EwErrorCode setEwPointOrientation (EwPointOrientation ewSyConnectionPointFlowDirection);
85 
86 
94  DOUBLE getXPos (EwErrorCode* errorCode);
95 
96 
104  EwErrorCode setXPos (DOUBLE dXValue);
105 
106 
114  DOUBLE getYPos (EwErrorCode* errorCode);
115 
116 
124  EwErrorCode setYPos (DOUBLE dYValue);
125 
126 
134  DOUBLE getAngle (EwErrorCode* errorCode);
135 
136 
144  EwErrorCode setAngle (DOUBLE dAngle);
145 
146 
156 
157 
166  EwErrorCode setTerminationTypeCode (BSTR strTerminationTypeCode);
167 
168 };
169 
174 [
175  object,
176  uuid(960C29C7-51FA-452E-865E-59F7C0669A7A),
177  dual,
178  oleautomation,
179  nonextensible,
180  helpstring("IEwSymbolCircuitX Interface"),
181  pointer_default(unique)
182 ]
183 interface IEwSymbolCircuitX : IDispatch
184 {
185 
186 
194  EwErrorCode getNumber (LONG* lNo);
195 
196 
205 
206 
215 
216 
224  EwErrorCode getType (BSTR* pstrKeyCode);
225 
226 
235  EwErrorCode setType (BSTR strKeyCode);
236 
237 };
238 
239 
244 [
245  object,
246  uuid(02C2A32C-B421-42C8-9A7B-48BCF979D50C),
247  dual,
248  oleautomation,
249  nonextensible,
250  helpstring("IEwSymbolFiltersX Interface"),
251  pointer_default(unique)
252 ]
253 interface IEwSymbolFiltersX : IDispatch{
254 
259  LONG getClassNodeID ();
260 
261 
266  void setClassNodeID (LONG lNodeID);
267 
268 
274 
275 
280  void setEwSymbolType (EwSymbolType ewSymbolTypes);
281 
282 
287  BSTR getSymbolName ();
288 
289 
294  void setSymbolName (BSTR strName);
295 
296 
305  BSTR getDescription (BSTR lgCode, EwErrorCode* errorCode);
306 
307 
316  EwErrorCode setDescription (BSTR lgCode, BSTR val);
317 
318 
324 
325 
330  void setEwMeasurementType (EwMeasurementType ewMeasurementTypes);
331 
332 
337  BSTR getLibraryCode ();
338 
339 
344  void setLibraryCode (BSTR strLibraryCode);
345 
346 
352 
353 
358  void setManufacturer (BSTR strManufacturer);
359 
360 
365  BSTR getReference ();
366 
367 
372  void setReference (BSTR strReference);
373 
374 
380 
381 
386  void setModificationDateFrom (DATE modificationDateFrom);
387 
388 
394 
395 
400  void setModificationDateTo (DATE modificationDateTo);
401 
402 
408 
409 
414  void setCreationDateFrom (DATE creationDateFrom);
415 
416 
422 
423 
428  void setCreationDateTo (DATE creationDateTo);
429 
430 
436 
437 
442  void setEwSymbolCircuitCount (LONG lNbCircuit);
443 
444 
450 
451 
456  void setEwSymbolPointCount (LONG lConnectionPoint);
457 
458 
463  BSTR getRootMark ();
464 
465 
470  void setRootMark (BSTR strRootMark);
471 
472 
478 
479 
484  void setAssociatedMacro (BSTR strAssociatedMacro);
485 
486 
492 
493 
498  void setEwSymbolCrossRefType (EwSymbolCrossRefType symbolCrossRefTypes);
499 
500 
506 
507 
512  void setDisplayEwSymbolPoint (EwBooleanFiltersValue ewBooleanFiltersValues);
513 
514 
520 
521 
526  void setDoNotRotateAttributes (EwBooleanFiltersValue ewBooleanFiltersValues);
527 
528 
538  EwErrorCode getEwSymbolArray (VARIANT* pXArray);
539 
540 
541 };
542 
547 [
548  object,
549  uuid(90C1D0BC-FDC7-4410-BB37-2A86CA6CA1EC),
550  dual,
551  oleautomation,
552  nonextensible,
553  helpstring("IEwSymbolX Interface"),
554  pointer_default(unique)
555 ]
556 interface IEwSymbolX : IDispatch{
557 
558 
559 
560 
569  IEwSymbolCircuitX addEwSymbolCircuit (BSTR strCircuitCode, EwErrorCode* errorCode);
570 
571 
581 
582 
588 
589 
600 
601 
611  BSTR getDescription (BSTR lgCode, EwErrorCode* errorCode);
612 
613 
623  EwErrorCode setDescription (BSTR lgCode, BSTR strValue);
624 
625 
633  LONG getID (EwErrorCode* errorCode);
634 
635 
643  BSTR getReference (EwErrorCode* errorCode);
644 
645 
653  EwErrorCode setReference (BSTR strReference);
654 
655 
663  BSTR getManufacturer (EwErrorCode* errorCode);
664 
665 
673  EwErrorCode setManufacturer (BSTR strManufacturer);
674 
675 
683  LONG getClassNodeID (EwErrorCode* errorCode);
684 
685 
693  EwErrorCode setClassNodeID (LONG lNodeId);
694 
695 
703  BSTR getLibraryCode (EwErrorCode* errorCode);
704 
705 
713  EwErrorCode setLibraryCode (BSTR strLibraryCode);
714 
715 
723  DATE getModificationDate (EwErrorCode* errorCode);
724 
725 
733  DATE getCreationDate (EwErrorCode* errorCode);
734 
735 
744 
745 
753  BSTR getRootMark (EwErrorCode* errorCode);
754 
755 
763  EwErrorCode setRootMark (BSTR strRootMark);
764 
765 
773  BSTR getName (EwErrorCode* errorCode);
774 
775 
783  EwErrorCode setName (BSTR strSymbolName);
784 
785 
794 
795 
804 
805 
814 
815 
824 
825 
834 
835 
844 
845 
853  BSTR getAssociatedMacro (EwErrorCode* errorCode);
854 
855 
863  EwErrorCode setAssociatedMacro (BSTR strAssociatedMacro);
864 
865 
873  BSTR getStandard (EwErrorCode* errorCode);
874 
875 
883  EwErrorCode setStandard (BSTR strStandard);
884 
885 
893  VARIANT_BOOL isConnectionPointVisible (EwErrorCode* errorCode);
894 
895 
903  EwErrorCode showConnectionPoint (VARIANT_BOOL bVisible);
904 
905 
913  EwErrorCode getDoNotRotateAttributes (VARIANT_BOOL* pbRotate);
914 
915 
923  EwErrorCode setDoNotRotateAttributes (VARIANT_BOOL bRotate);
924 
925 
937 
938 
948 
949 
956  EwErrorCode remove ();
957 
958 
972  EwErrorCode insertFromDwg (BSTR strDwgFilePath);
973 
974 
982  BOOL isAlreadyOpened (EwErrorCode* errorCode);
983 
984 
993 
994 
1004 
1005 
1011 
1012 
1023 
1024 
1033  BSTR getModifiedBy (EwErrorCode* eErrorCode);
1034 
1035 
1036 };
1037 
1042 [
1043  object,
1044  uuid(D4CAA186-3BD6-462A-A3DC-E1DB39B7941E),
1045  dual,
1046  oleautomation,
1047  nonextensible,
1048  helpstring("IEwSymbolManagerX Interface"),
1049  pointer_default(unique)
1050 ]
1051 interface IEwSymbolManagerX : IDispatch
1052 {
1058 
1059 
1063  LONG getCount ();
1064 
1065 
1069  VARIANT getEwSymbolArray (EwErrorCode* errorCode);
1070 
1071 
1077 
1078 
1089  IEwSymbolX at (int iIndex, EwErrorCode* errorCode);
1090 
1091 
1104  IEwSymbolX findEwSymbolXById (long lId, EwErrorCode* pErrorCode);
1105 
1106 
1119  IEwSymbolX findEwSymbolXByName (BSTR strName, EwErrorCode* errorCode);
1120 
1121 }
EwErrorCode getType(BSTR *pstrKeyCode)
Get the type of the circuit.
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.
IEwSymbolX findEwSymbolXById(long lId, EwErrorCode *pErrorCode)
Find an IEwSymbolX by ID.
IEwSymbolFiltersX newEwSymbolFilters()
Create a IEwSymbolFiltesrX object to get symbols af associated environment.
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 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 setEwPointOrientation(EwPointOrientation ewSyConnectionPointFlowDirection)
Set the flow direction of the connection point.
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:252
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.
EwErrorCode setEwSymbolCrossRefType(EwSymbolCrossRefType symbolCrossRefType)
Set the cross reference type of the symbol.
EwErrorCode setEwMeasurementType(EwMeasurementType ewMeasurementType)
Set the measurement type of the symbol.
IEwSymbolX at(int iIndex, EwErrorCode *errorCode)
Return an IEwSymbolX at a given position from the associated environment.
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:253
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.
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.
EwErrorCode setEwSymbolType(EwSymbolType ewSymbolTypes)
Set the type of the symbol.
void setModificationDateTo(DATE modificationDateTo)
Set/reset the "modification date to" of the filter.
void setEwSymbolType(EwSymbolType ewSymbolTypes)
Set/reset the symbol type 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:184
DOUBLE getAngle(EwErrorCode *errorCode)
Get the angle of the connection point.
EwErrorCode setAssociatedMacro(BSTR strAssociatedMacro)
Set the associated macro of the symbol.
EwErrorCode getDoNotRotateAttributes(VARIANT_BOOL *pbRotate)
Get value of option "Do not rotate attributes".
VARIANT_BOOL isConnectionPointVisible(EwErrorCode *errorCode)
Check if connection point are displayed.
DATE getCreationDate(EwErrorCode *errorCode)
Get the creation date 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:392
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.
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:419
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:33
void setEwMeasurementType(EwMeasurementType ewMeasurementTypes)
Set/reset the measurement of the filter.
LONG getEwSymbolCircuitCount()
Get the number of circuit of the filter.
EwErrorCode getEwSymbolArray(VARIANT *pXArray)
Return Array of Symbol according to 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.
EwMeasurementType getEwMeasurementType(EwErrorCode *errorCode)
Return the measurement type of the symbol.
BSTR getTerminationTypeCode(EwErrorCode *pErrorCode)
Get the termination type code of the connection point.
void setLibraryCode(BSTR strLibraryCode)
Set/reset the library code 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.
void setDoNotRotateAttributes(EwBooleanFiltersValue ewBooleanFiltersValues)
Set the value of "do not rotate attributes" of the filter.
EwErrorCode setEwCircuitPassingType(EwCircuitPassingType passingType)
Set the passing type of the circuit.
BSTR getName(EwErrorCode *errorCode)
Get the name of the symbol.
VARIANT getEwSymbolArray(EwErrorCode *errorCode)
return the array of IEwSymbolX of associated environment
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:643
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.
void setDisplayEwSymbolPoint(EwBooleanFiltersValue ewBooleanFiltersValues)
Set the display connection point value 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.
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:556
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:239
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:1052
EwErrorCode setClassNodeID(LONG lNodeId)
Set the classification node ID of the symbol.
void setEwSymbolCrossRefType(EwSymbolCrossRefType symbolCrossRefTypes)
Set/reset the type of cross reference 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:632
EwErrorCode getEwCircuitPassingType(EwCircuitPassingType *pPassingType)
Get the passing type of the circuit.


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