Hide Table of Contents
SOLIDWORKS Electrical API  2022.0.0
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 
68  DATE getCreationDate (EwErrorCode* errorCode);
69 
70 
71 
80  EwErrorCode setName (BSTR strName);
81 
82 
91  BSTR getName (EwErrorCode* errorCode);
92 
93 
103 
104 
113  long getFileSize (EwErrorCode* errorCode);
114 
115 
124  BSTR getEventDetails (EwErrorCode* errorCode);
125 
126 
138 
139 
149 
150 
161  VARIANT_BOOL getGenerateAutomatedDrawings (EwErrorCode* errorCode);
162 
163 
174  EwErrorCode setGenerateAutomatedDrawings (VARIANT_BOOL bGenerateAutomatedDrawings);
175 
176 
177 };
178 
183 [
184  object,
185  uuid(CA659828-F3E4-4EFB-95F2-065AA680366E),
186  dual,
187  nonextensible,
188  pointer_default(unique)
189 ]
190 interface IEwProjectSnapshotManagerX : IDispatch
191 {
192 
199  LONG getCount (EwErrorCode* errorCode);
200 
201 
210 
211 
221  IEwProjectSnapshotX at (int iIndex, EwErrorCode* errorCode);
222 
223 
235 
236 
237 };
238 
239 
244 [
245  object,
246  uuid(5A6E7500-8AD2-45D5-BD2B-26EC4D48D83A),
247  dual,
248  nonextensible,
249  pointer_default(unique)
250 ]
251 interface IEwProjectUpdateReplaceDataX : IDispatch
252 {
263 
264 
273 
274 
283  EwErrorCode process (EwProjectDataActionType eDataProjectActionType);
284 
285 };
286 
291 [
292  object,
293  uuid(A166A78B-30A4-4A18-92F3-5F0B26C6B03E),
294  dual,
295  nonextensible,
296  pointer_default(unique)
297 ]
298 interface IEwProjectNumberWiresX : IDispatch
299 {
308  VARIANT_BOOL getActionOnManualNumber (EwErrorCode* errorCode);
309 
310 
320  EwErrorCode setActionOnManualNumber (VARIANT_BOOL bActionOnManualNumber);
321 
322 
331  VARIANT_BOOL getResetPosition (EwErrorCode* errorCode);
332 
333 
343  EwErrorCode setResetPosition (VARIANT_BOOL bResetPosition);
344 
345 
354 
355 
365 
366 
373  VARIANT getSelection (EwErrorCode* errorCode);
374 
375 
387  EwErrorCode setSelection (VARIANT vIDArray);
388 
389 
399 
400 };
401 
406 [
407  object,
408  uuid(33FE2367-ED47-4BD2-9469-787A0AEFB1FF),
409  dual,
410  nonextensible,
411  pointer_default(unique)
412 ]
413 interface IEwProjectNumberMarksX : IDispatch
414 {
423  VARIANT_BOOL getActionOnManualNumber (EwErrorCode* errorCode);
424 
425 
434  EwErrorCode setActionOnManualNumber (VARIANT_BOOL bActionOnManualNumber);
435 
436 
444  long getNumberObjectType (EwErrorCode* errorCode);
445 
446 
455 
456 
464  EwErrorCode setNumberObjectType (long lNumberObjectType);
465 
466 
476 
477 };
478 
483 [
484  object,
485  uuid(BACCE4FF-4ACC-4BB4-8573-FF8399EECEBA),
486  dual,
487  nonextensible,
488  pointer_default(unique)
489 ]
490 interface IEwProjectAutomaticArrowsX : IDispatch
491 {
500  VARIANT_BOOL getActionOnManual (EwErrorCode* errorCode);
501 
502 
511  EwErrorCode setActionOnManual (VARIANT_BOOL bActionOnManual);
512 
513 
522 
523 
533 
534 
541  VARIANT getSelection (EwErrorCode* errorCode);
542 
543 
555  EwErrorCode setSelection (VARIANT vIDArray);
556 
557 
566  BSTR getOriginSymbol (EwErrorCode* errorCode);
567 
568 
578  EwErrorCode setOriginSymbol (BSTR strBlockName);
579 
580 
590 
591 
601  EwErrorCode setDestinationSymbol (BSTR strBlockName);
602 
603 
613 
614 
624 
625 
635 
636 
646 
647 
657  EwErrorCode process (EwAutoArrowActionType eAutomaticArrowActionType);
658 
659 };
660 
661 
666 [
667  object,
668  uuid(91474E70-76FC-4816-8405-8AFF3975C0C6),
669  dual,
670  nonextensible,
671  pointer_default(unique)
672 ]
673 interface IEwProjectNumberDocumentsX : IDispatch
674 {
683  VARIANT_BOOL getActionOnManualNumber (EwErrorCode* errorCode);
684 
685 
694  EwErrorCode setActionOnManualNumber (VARIANT_BOOL bActionOnManualNumber);
695 
696 
705 
706 
716 
717 
724  VARIANT getSelection (EwErrorCode* errorCode);
725 
726 
738  EwErrorCode setSelection (VARIANT vIDArray);
739 
740 
755  int getFirstNumber (EwSelectionType eSelection, EwErrorCode* errorCode);
756 
757 
772  EwErrorCode setFirstNumber (EwSelectionType eSelection, int iFirstNumber);
773 
774 
788  int getIncrement (EwSelectionType eSelection, EwErrorCode* errorCode);
789 
790 
806  EwErrorCode setIncrement (EwSelectionType eSelection, int iIncrement);
807 
808 
809 
819 
820 };
821 
826 [
827  object,
828  uuid(B62B5A84-7357-4A80-8E27-CF0A5332F734),
829  dual,
830  nonextensible,
831  pointer_default(unique)
832 ]
833 interface IEwProjectOptimizeWireOrderX : IDispatch
834 {
843  VARIANT_BOOL getActionOnManual (EwErrorCode* errorCode);
844 
845 
854  EwErrorCode setActionOnManual (VARIANT_BOOL bActionOnManual);
855 
856 
865 
866 
876 
877 
884  VARIANT getSelection (EwErrorCode* errorCode);
885 
886 
898  EwErrorCode setSelection (VARIANT vIDArray);
899 
900 
909  VARIANT_BOOL getActionRemoveWireCableCore (EwErrorCode* errorCode);
910 
911 
920  EwErrorCode setActionRemoveWireCableCore (VARIANT_BOOL bActionRemove);
921 
922 
931  VARIANT_BOOL getActionRemoveBridges (EwErrorCode* errorCode);
932 
933 
942  EwErrorCode setActionRemoveBridges (VARIANT_BOOL bActionRemove);
943 
944 
953 
954 
963 
964 
973 
974 };
EwErrorCode process(EwNumberMarkAction eNumberAction)
Process function to renumber marks in the current project.
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:891
VARIANT_BOOL getActionRemoveBridges(EwErrorCode *errorCode)
Return true if the action should be to remove bridges.
EwErrorCode setSelectionType(EwSelectionType eSelectionType)
Set the EwSelectionType enum to specify the type of selection to use.
EwAutoArrowActionType
Enum which contains all action for the origin destination automatic insertion.
Definition: EwEnumeration.idl:869
EwProjectDataActionType
Action type to update or replace data in project.
Definition: EwEnumeration.idl:802
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:789
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:252
EwErrorCode setSelectionType(EwSelectionType eSelectionType)
Set the EwSelectionType enum to specify the type of selection to use.
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...
IEwProjectSnapshotX findProjectSnapshotByID(LONG lId, EwErrorCode *errorCode)
Return an IEwProjectSnapshotX object by id .
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:814
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:299
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:848
EwErrorCode setActionOnManual(VARIANT_BOOL bActionOnManual)
Set this value to true if the action should be done on the Manual arrows.
EwObjectType
Enum which contains all kind of object.
Definition: EwEnumeration.idl:828
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 vIDArray)
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 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:414
EwErrorCode setIncrement(EwSelectionType eSelection, int iIncrement)
Set the increment for one selection enum.
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:258
EwErrorCode setSelection(VARIANT vIDArray)
Set the array of ID according to selection type.
Use this interface to manage snapshot manager inside a project.
Definition: EwProjectProcessObjects.idl:191
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:273
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:491
EwNumberMarkAction
All the possible actions for renumber marks.
Definition: EwEnumeration.idl:880
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.
EwErrorCode setSelectionType(EwSelectionType eSelectionType)
Set the EwSelectionType enum to specify the type of selection to use.
EwErrorCode process(EwNumberMarkAction eNumberAction)
Process function to renumber marks 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.
VARIANT_BOOL getResetPosition(EwErrorCode *errorCode)
Return true if reset position of wire marks is activated.
EwErrorCode setSelection(VARIANT vIDArray)
Set the array of ID according to selection type.
EwErrorCode setName(BSTR strName)
Set the name of this snapshot.
Use this interface to manage the renumber documents.
Definition: EwProjectProcessObjects.idl:674
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 setSelectionType(EwSelectionType eSelectionType)
Set the EwSelectionType enum to specify the type of selection to use.
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.
EwAutoArrowLocConnectType getLocationConnectionType(EwErrorCode *errorCode)
Return the EwAutoArrowLocConnectType enum to specify the connection type relate with the file locatio...
EwErrorCode setSelection(VARIANT vIDArray)
Set the array of ID according to selection type.
IEwProjectSnapshotX at(int iIndex, EwErrorCode *errorCode)
Return an IEwProjectSnapshotX object from the associated project.
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:834
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:859
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) 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.