Hide Table of Contents
SOLIDWORKS Electrical API  2020.0.5
Electrical API
EwProjectProcessObjects.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 "EwObjectBase.idl";
11 
16 [
17  object,
18  uuid(BD996DFE-0BDD-4983-A460-680C2A9B19A0),
19  dual,
20  nonextensible,
21  pointer_default(unique)
22 ]
23 interface IEwProjectSnapshotX : IDispatch
24 {
25 
26 
27 
28 
29 
39  EwErrorCode remove ();
40 
41 
42 
51 
52 
53 
57  LONG getID ();
58 
59 
67  DATE getCreationDate (EwErrorCode* errorCode);
68 
69 
70 
78  EwErrorCode setName (BSTR bstrName);
79 
80 
88  BSTR getName (EwErrorCode* errorCode);
89 
90 
99 
100 
108  long getFileSize (EwErrorCode* errorCode);
109 
110 
118  BSTR getEventDetails (EwErrorCode* errorCode);
119 
120 
131 
132 
141 
142 
152  VARIANT_BOOL getGenerateAutomatedDrawings (EwErrorCode* errorCode);
153 
154 
164  EwErrorCode setGenerateAutomatedDrawings (VARIANT_BOOL bGenerateAutomatedDrawings);
165 
166 
167 };
168 
173 [
174  object,
175  uuid(CA659828-F3E4-4EFB-95F2-065AA680366E),
176  dual,
177  nonextensible,
178  pointer_default(unique)
179 ]
180 interface IEwProjectSnapshotManagerX : IDispatch
181 {
182 
189  LONG getCount (EwErrorCode* errorCode);
190 
191 
200 
201 
211  IEwProjectSnapshotX at (int iIndex, EwErrorCode* errorCode);
212 
213 
225 
226 
227 };
228 
229 
234 [
235  object,
236  uuid(5A6E7500-8AD2-45D5-BD2B-26EC4D48D83A),
237  dual,
238  nonextensible,
239  pointer_default(unique)
240 ]
241 interface IEwProjectUpdateReplaceDataX : IDispatch
242 {
253 
254 
263 
264 
273  EwErrorCode process (EwProjectDataActionType eDataProjectActionType);
274 
275 };
276 
281 [
282  object,
283  uuid(A166A78B-30A4-4A18-92F3-5F0B26C6B03E),
284  dual,
285  nonextensible,
286  pointer_default(unique)
287 ]
288 interface IEwProjectNumberWiresX : IDispatch
289 {
298  VARIANT_BOOL getActionOnManualNumber (EwErrorCode* errorCode);
299 
300 
310  EwErrorCode setActionOnManualNumber (VARIANT_BOOL bActionOnManualNumber);
311 
312 
321  VARIANT_BOOL getResetPosition (EwErrorCode* errorCode);
322 
323 
333  EwErrorCode setResetPosition (VARIANT_BOOL bResetPosition);
334 
335 
344 
345 
355 
356 
363  VARIANT getSelection (EwErrorCode* errorCode);
364 
365 
377  EwErrorCode setSelection (VARIANT aIDArray);
378 
379 
389 
390 };
391 
396 [
397  object,
398  uuid(33FE2367-ED47-4BD2-9469-787A0AEFB1FF),
399  dual,
400  nonextensible,
401  pointer_default(unique)
402 ]
403 interface IEwProjectNumberMarksX : IDispatch
404 {
413  VARIANT_BOOL getActionOnManualNumber (EwErrorCode* errorCode);
414 
415 
424  EwErrorCode setActionOnManualNumber (VARIANT_BOOL bActionOnManualNumber);
425 
426 
434  long getNumberObjectType (EwErrorCode* errorCode);
435 
436 
445 
446 
454  EwErrorCode setNumberObjectType (long lNumberObjectType);
455 
456 
465 
466 };
467 
472 [
473  object,
474  uuid(BACCE4FF-4ACC-4BB4-8573-FF8399EECEBA),
475  dual,
476  nonextensible,
477  pointer_default(unique)
478 ]
479 interface IEwProjectAutomaticArrowsX : IDispatch
480 {
489  VARIANT_BOOL getActionOnManual (EwErrorCode* errorCode);
490 
491 
500  EwErrorCode setActionOnManual (VARIANT_BOOL bActionOnManual);
501 
502 
511 
512 
522 
523 
530  VARIANT getSelection (EwErrorCode* errorCode);
531 
532 
544  EwErrorCode setSelection (VARIANT aIDArray);
545 
546 
555  BSTR getOriginSymbol (EwErrorCode* errorCode);
556 
557 
567  EwErrorCode setOriginSymbol (BSTR strBlockName);
568 
569 
579 
580 
590  EwErrorCode setDestinationSymbol (BSTR strBlockName);
591 
592 
602 
603 
613 
614 
624 
625 
635 
636 
646  EwErrorCode process (EwAutoArrowActionType eAutomaticArrowActionType);
647 
648 };
649 
650 
655 [
656  object,
657  uuid(91474E70-76FC-4816-8405-8AFF3975C0C6),
658  dual,
659  nonextensible,
660  pointer_default(unique)
661 ]
662 interface IEwProjectNumberDocumentsX : IDispatch
663 {
672  VARIANT_BOOL getActionOnManualNumber (EwErrorCode* errorCode);
673 
674 
683  EwErrorCode setActionOnManualNumber (VARIANT_BOOL bActionOnManualNumber);
684 
685 
694 
695 
705 
706 
713  VARIANT getSelection (EwErrorCode* errorCode);
714 
715 
727  EwErrorCode setSelection (VARIANT aIDArray);
728 
729 
744  int getFirstNumber (EwSelectionType eSelection, EwErrorCode* errorCode);
745 
746 
761  EwErrorCode setFirstNumber (EwSelectionType eSelection, int iFirstNumber);
762 
763 
777  int getIncrement (EwSelectionType eSelection, EwErrorCode* errorCode);
778 
779 
794  EwErrorCode setIncrement (EwSelectionType eSelection, int iIncrement);
795 
796 
797 
806 
807 };
808 
813 [
814  object,
815  uuid(B62B5A84-7357-4A80-8E27-CF0A5332F734),
816  dual,
817  nonextensible,
818  pointer_default(unique)
819 ]
820 interface IEwProjectOptimizeWireOrderX : IDispatch
821 {
830  VARIANT_BOOL getActionOnManual (EwErrorCode* errorCode);
831 
832 
841  EwErrorCode setActionOnManual (VARIANT_BOOL bActionOnManual);
842 
843 
852 
853 
863 
864 
871  VARIANT getSelection (EwErrorCode* errorCode);
872 
873 
885  EwErrorCode setSelection (VARIANT aIDArray);
886 
887 
896  VARIANT_BOOL getActionRemoveWireCableCore (EwErrorCode* errorCode);
897 
898 
907  EwErrorCode setActionRemoveWireCableCore (VARIANT_BOOL bActionRemove);
908 
909 
918  VARIANT_BOOL getActionRemoveBridges (EwErrorCode* errorCode);
919 
920 
929  EwErrorCode setActionRemoveBridges (VARIANT_BOOL bActionRemove);
930 
931 
940 
941 
950 
951 
960 
961 };
EwErrorCode setSelection(VARIANT aIDArray)
Set the array of ID according to selection type.
VARIANT_BOOL getActionOnManualNumber(EwErrorCode *errorCode)
Return true if the action should be done on the Manual number.
EwErrorCode setActionRemoveWireCableCore(VARIANT_BOOL bActionRemove)
Set this value to true if the action should be to remove the cable core association.
EwErrorCode setDestinationSymbol(BSTR strBlockName)
Set the block name of symbol used for destination symbol.
EwWireDirType
All the cabling direction.
Definition: EwEnumeration.idl:865
VARIANT_BOOL getActionRemoveBridges(EwErrorCode *errorCode)
Return true if the action should be to remove bridges.
EwAutoArrowActionType
Enum which contains all action for the origin destination automatic insertion.
Definition: EwEnumeration.idl:843
EwProjectDataActionType
Action type to update or replace data in project.
Definition: EwEnumeration.idl:776
EwErrorCode setResetPosition(VARIANT_BOOL bResetPosition)
Set this value to true to reset the position of wire marks.
EwErrorCode addProjectDataObjectType(EwProjectDataObjectType eDataProjectObjectType)
Add the type of object to modify.
int getFirstNumber(EwSelectionType eSelection, EwErrorCode *errorCode)
Get the first number for one selection enum.
VARIANT_BOOL getActionOnManualNumber(EwErrorCode *errorCode)
Return true if the action should be done on the Manual marks.
EwErrorCode setActionOnManualNumber(VARIANT_BOOL bActionOnManualNumber)
Set this value to true if the action should be done on the Manual marks.
EwEventCode
Events leading to snapshot.
Definition: EwEnumeration.idl:763
EwErrorCode setSelection(VARIANT aIDArray)
Set the array of ID according to selection type.
EwAutoArrowMarkType getEquipotentialConnectionType(EwErrorCode *errorCode)
Return the EwAutoArrowMarkType enum to specify the equipotential connection with mark.
Use this interface to manage the update of project data from libraries.
Definition: EwProjectProcessObjects.idl:242
EwErrorCode setNumberObjectType(long lNumberObjectType)
Set the EwObjectType enum to specify the type of object to apply.
EwErrorCode
All errors codes for this API.
Definition: EnumDefinition.idl:21
EwErrorCode resetProjectDataObjectType()
Reset the type of object to modify.
EwSelectionType getSelectionType(EwErrorCode *errorCode)
Return the EwSelectionType enum to specify the type of selection to use.
EwSelectionType getSelectionType(EwErrorCode *errorCode)
Return the EwSelectionType enum to specify the type of selection to use.
VARIANT_BOOL getActionRemoveWireCableCore(EwErrorCode *errorCode)
Return true if the action should be to remove the cable core association.
EwErrorCode setActionOnManual(VARIANT_BOOL bActionOnManual)
Set this value to true if the action should be done on the Manual wire cabling order.
VARIANT_BOOL getActionOnManualNumber(EwErrorCode *errorCode)
Return true if the action should be done on the Manual marks.
VARIANT_BOOL getGenerateAutomatedDrawings(EwErrorCode *errorCode)
Option to update all generated files like Terminal strips or Reports which have been added to the pro...
EwErrorCode create()
Create a snapshot of the current project.
EwEventCode getEventType(EwErrorCode *errorCode)
Get the event type of this snapshot.
VARIANT_BOOL getActionOnManual(EwErrorCode *errorCode)
Return true if the action should be done on the Manual wire cabling order.
EwProjectDataObjectType
Type of object to update or replace data in project.
Definition: EwEnumeration.idl:788
EwWireDirType getWireDirectionType(EwErrorCode *errorCode)
Return the EwWireDirectionType enum to specify the cabling direction.
Use this interface to manage the numbering or renumbering of wires.
Definition: EwProjectProcessObjects.idl:289
EwErrorCode setActionRemoveBridges(VARIANT_BOOL bActionRemove)
Set this value to true if the action should be to remove bridges.
EwAutoArrowLocConnectType
Enum which contains all connection types related with the file location for the Origin Destination au...
Definition: EwEnumeration.idl:822
EwErrorCode setActionOnManual(VARIANT_BOOL bActionOnManual)
Set this value to true if the action should be done on the Manual arrows.
EwErrorCode setSelectionType(EwSelectionType eSelection)
Set the EwSelectionType enum to specify the type of selection to use.
EwObjectType
Enum which contains all kind of object.
Definition: EwEnumeration.idl:802
VARIANT getSelection(EwErrorCode *errorCode)
Return the array of ID used to specify the selection of objects to include in renumbering process.
DATE getCreationDate(EwErrorCode *errorCode)
Get the creation date of this snapshot object.
EwSelectionType getSelectionType(EwErrorCode *errorCode)
Return the EwSelectionType enum to specify the type of selection to use.
EwErrorCode setWireDirectionType(EwWireDirType eWireDirectionType)
Set the EwWireDirectionType enum to specify the cabling direction.
EwErrorCode update()
Update the object inside the current project.
EwErrorCode setSelection(VARIANT aIDArray)
Set the array of ID according to selection type.
EwErrorCode process(EwProjectDataActionType eDataProjectActionType)
Process function to update or replace data in the current project.
EwErrorCode setLocationConnectionType(EwAutoArrowLocConnectType eAutomaticArrowLocConnectionType)
Set the EwAutoArrowLocConnectType enum to specify the connection type relate with the file location f...
EwErrorCode process(EwNumberMarkAction eEwNumberAction)
Process function to renumber marks in the current project.
EwErrorCode restore()
Restore a snapshot of the current project.
EwErrorCode setGenerateAutomatedDrawings(VARIANT_BOOL bGenerateAutomatedDrawings)
Option to update all generated files like Terminal strips or Reports which have been added to the pro...
Use this interface to manage the renumber marks.
Definition: EwProjectProcessObjects.idl:404
EwErrorCode setIncrement(EwSelectionType eSelection, int iIncrement)
Set the increment for one selection enum.
EwErrorCode setSelection(VARIANT aIDArray)
Set the array of ID according to selection type.
EwErrorCode setActionOnManualNumber(VARIANT_BOOL bActionOnManualNumber)
Set this value to true if the action should be done on the Manual marks.
VARIANT getSelection(EwErrorCode *errorCode)
Return the array of ID used to specify the selection of objects to include in renumbering process.
EwNumberWireAction
All the possible actions for renumber wires.
Definition: EnumDefinition.idl:236
Use this interface to manage snapshot manager inside a project.
Definition: EwProjectProcessObjects.idl:181
BSTR getOriginSymbol(EwErrorCode *errorCode)
Get the block name of symbol used for origin symbol.
EwErrorCode setFirstNumber(EwSelectionType eSelection, int iFirstNumber)
Set the first number for one selection enum.
EwErrorCode setEquipotentialConnectionType(EwAutoArrowMarkType eAutomaticArrowMarkType)
Set the the EwAutoArrowMarkType enum to specify the equipotential connection with mark.
EwSelectionType
All the selection types.
Definition: EnumDefinition.idl:251
Use this interface to manage snapshot inside a project.
Definition: EwProjectProcessObjects.idl:24
EwErrorCode process(EwNumberWireAction eEwNumberAction)
Process function to number or renumber wires in the current project.
Use this interface to manage the Origin Destination automatic insertion.
Definition: EwProjectProcessObjects.idl:480
IEwProjectSnapshotX findProjectSnapshotByID(LONG lId, EwErrorCode *pErrorCode)
Return an IEwProjectSnapshotX object by id .
EwNumberMarkAction
All the possible actions for renumber marks.
Definition: EwEnumeration.idl:854
EwErrorCode setName(BSTR bstrName)
Set the name of this snapshot.
EwErrorCode addNumberObjectType(EwObjectType eNumberObjectType)
Add the EwObjectType enum to specify the type of object to apply.
EwErrorCode process(EwAutoArrowActionType eAutomaticArrowActionType)
Process function to insert Origin Destination automatic arrows in the current project.
IEwProjectSnapshotX newEwProjectSnapshot(EwErrorCode *errorCode)
Create an IEwProjectSnapshotX object from the associated project.
BSTR getName(EwErrorCode *errorCode)
Get the name of this snapshot.
EwErrorCode setSelectionType(EwSelectionType eSelection)
Set the EwSelectionType enum to specify the type of selection to use.
VARIANT_BOOL getResetPosition(EwErrorCode *errorCode)
Return true if reset position of wire marks is activated.
Use this interface to manage the renumber documents.
Definition: EwProjectProcessObjects.idl:663
EwErrorCode process(EwNumberMarkAction eEwNumberAction)
Process function to renumber marks in the current project.
EwSelectionType getSelectionType(EwErrorCode *errorCode)
Return the EwSelectionType enum to specify the type of selection to use.
long getFileSize(EwErrorCode *errorCode)
Get the estimate file size in MB of this snapshot.
EwErrorCode setActionOnManualNumber(VARIANT_BOOL bActionOnManualNumber)
Set this value to true if the action should be done on the Manual number.
LONG getCount(EwErrorCode *errorCode)
Return the number of snapshot of associated project.
BSTR getEventDetails(EwErrorCode *errorCode)
Get the event details of this snapshot.
EwErrorCode setSelectionType(EwSelectionType eSelection)
Set the EwSelectionType enum to specify the type of selection to use.
EwAutoArrowLocConnectType getLocationConnectionType(EwErrorCode *errorCode)
Return the EwAutoArrowLocConnectType enum to specify the connection type relate with the file locatio...
IEwProjectSnapshotX at(int iIndex, EwErrorCode *errorCode)
Return an IEwProjectSnapshotX object from the associated project.
EwErrorCode setSelectionType(EwSelectionType eSelection)
Set the EwSelectionType enum to specify the type of selection to use.
int getIncrement(EwSelectionType eSelection, EwErrorCode *errorCode)
Get the increment for one selection enum.
BSTR getDestinationSymbol(EwErrorCode *errorCode)
Get the block name of symbol used for destination symbol.
Use this interface to manage the optimize wire order.
Definition: EwProjectProcessObjects.idl:821
VARIANT getSelection(EwErrorCode *errorCode)
Return the array of ID used to specify the selection of objects to process.
EwAutoArrowMarkType
Enum which contains marks type that we want to be aware for the origin destination automatic insertio...
Definition: EwEnumeration.idl:833
long getNumberObjectType(EwErrorCode *errorCode)
Return the combination of EwObjectType enum to specify the type of objects to apply.
EwErrorCode setOriginSymbol(BSTR strBlockName)
Set the block name of symbol used for origin symbol.
VARIANT_BOOL getActionOnManual(EwErrorCode *errorCode)
Return true if the action should be done on the Manual arrows.
VARIANT getSelection(EwErrorCode *errorCode)
Return the array of ID used to specify the selection of objects to include in Origin Destination auto...
EwErrorCode process()
Process function to optimize wire order in the current project.


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