Hide Table of Contents
SOLIDWORKS Electrical API 2025.0.0
Electrical API
EwProjectProcessObjects.idl
Go to the documentation of this file.
1#pragma once
2
3#if (__midl >= 501)
4midl_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(BD996DFE-0BDD-4983-A460-680C2A9B19A0),
19 dual,
20 nonextensible,
21 pointer_default(unique)
22]
23interface 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
81 EwErrorCode setName (BSTR strName);
82
83
92 BSTR getName (EwErrorCode* errorCode);
93
94
104
105
114 long getFileSize (EwErrorCode* errorCode);
115
116
125 BSTR getEventDetails (EwErrorCode* errorCode);
126
127
139
140
150
151
162 VARIANT_BOOL getGenerateAutomatedDrawings (EwErrorCode* errorCode);
163
164
175 EwErrorCode setGenerateAutomatedDrawings (VARIANT_BOOL bGenerateAutomatedDrawings);
176
177
190 BSTR getDescription (BSTR strLanguage, EwErrorCode* errorCode);
191
192
207 EwErrorCode setDescription (BSTR strLanguage, BSTR strDescription);
208
209};
210
215[
216 object,
217 uuid(CA659828-F3E4-4EFB-95F2-065AA680366E),
218 dual,
219 nonextensible,
220 pointer_default(unique)
221]
222interface IEwProjectSnapshotManagerX : IDispatch
223{
224
231 LONG getCount (EwErrorCode* errorCode);
232
233
242
243
253 IEwProjectSnapshotX at (int iIndex, EwErrorCode* errorCode);
254
255
267
268
269};
270
271
276[
277 object,
278 uuid(5A6E7500-8AD2-45D5-BD2B-26EC4D48D83A),
279 dual,
280 nonextensible,
281 pointer_default(unique)
282]
283interface IEwProjectUpdateReplaceDataX : IDispatch
284{
295
296
304
305
315
316};
317
322[
323 object,
324 uuid(A166A78B-30A4-4A18-92F3-5F0B26C6B03E),
325 dual,
326 nonextensible,
327 pointer_default(unique)
328]
329interface IEwProjectNumberWiresX : IDispatch
330{
339 VARIANT_BOOL getActionOnManualNumber (EwErrorCode* errorCode);
340
341
351 EwErrorCode setActionOnManualNumber (VARIANT_BOOL bActionOnManualNumber);
352
353
362 VARIANT_BOOL getResetPosition (EwErrorCode* errorCode);
363
364
374 EwErrorCode setResetPosition (VARIANT_BOOL bResetPosition);
375
376
385
386
396
397
404 VARIANT getSelection (EwErrorCode* errorCode);
405
406
418 EwErrorCode setSelection (VARIANT vIDArray);
419
420
430
431};
432
437[
438 object,
439 uuid(33FE2367-ED47-4BD2-9469-787A0AEFB1FF),
440 dual,
441 nonextensible,
442 pointer_default(unique)
443]
444interface IEwProjectNumberMarksX : IDispatch
445{
454 VARIANT_BOOL getActionOnManualNumber (EwErrorCode* errorCode);
455
456
465 EwErrorCode setActionOnManualNumber (VARIANT_BOOL bActionOnManualNumber);
466
467
476
477
486
487
495 EwErrorCode setNumberObjectType (long lNumberObjectType);
496
497
506 VARIANT getSelection (EwErrorCode* errorCode);
507
508
517 EwErrorCode setSelection (VARIANT vIDArray);
518
519
535 int getStartNumber (EwObjectType eObjectType, EwErrorCode* errorCode);
536
537
554 EwErrorCode setStartNumber (EwObjectType eObjectType, int iStartNumber);
555
556
576 int getStepIncrement (EwObjectType eObjectType, EwErrorCode* errorCode);
577
578
598 EwErrorCode setStepIncrement (EwObjectType eObjectType, int iIncrement);
599
600
610
611};
612
617[
618 object,
619 uuid(BACCE4FF-4ACC-4BB4-8573-FF8399EECEBA),
620 dual,
621 nonextensible,
622 pointer_default(unique)
623]
624interface IEwProjectAutomaticArrowsX : IDispatch
625{
634 VARIANT_BOOL getActionOnManual (EwErrorCode* errorCode);
635
636
645 EwErrorCode setActionOnManual (VARIANT_BOOL bActionOnManual);
646
647
656
657
667
668
675 VARIANT getSelection (EwErrorCode* errorCode);
676
677
689 EwErrorCode setSelection (VARIANT vIDArray);
690
691
700 BSTR getOriginSymbol (EwErrorCode* errorCode);
701
702
712 EwErrorCode setOriginSymbol (BSTR strBlockName);
713
714
724
725
736
737
747
748
758
759
769
770
780
781
791 EwErrorCode process (EwAutoArrowActionType eAutomaticArrowActionType);
792
793};
794
795
800[
801 object,
802 uuid(91474E70-76FC-4816-8405-8AFF3975C0C6),
803 dual,
804 nonextensible,
805 pointer_default(unique)
806]
807interface IEwProjectNumberDocumentsX : IDispatch
808{
817 VARIANT_BOOL getActionOnManualNumber (EwErrorCode* errorCode);
818
819
828 EwErrorCode setActionOnManualNumber (VARIANT_BOOL bActionOnManualNumber);
829
830
839
840
850
851
858 VARIANT getSelection (EwErrorCode* errorCode);
859
860
872 EwErrorCode setSelection (VARIANT vIDArray);
873
874
889 int getFirstNumber (EwSelectionType eSelection, EwErrorCode* errorCode);
890
891
907 EwErrorCode setFirstNumber (EwSelectionType eSelection, int iFirstNumber);
908
909
923 int getIncrement (EwSelectionType eSelection, EwErrorCode* errorCode);
924
925
941 EwErrorCode setIncrement (EwSelectionType eSelection, int iIncrement);
942
943
944
954
955};
956
961[
962 object,
963 uuid(B62B5A84-7357-4A80-8E27-CF0A5332F734),
964 dual,
965 nonextensible,
966 pointer_default(unique)
967]
968interface IEwProjectOptimizeWireOrderX : IDispatch
969{
978 VARIANT_BOOL getActionOnManual (EwErrorCode* errorCode);
979
980
989 EwErrorCode setActionOnManual (VARIANT_BOOL bActionOnManual);
990
991
1000
1001
1011
1012
1019 VARIANT getSelection (EwErrorCode* errorCode);
1020
1021
1033 EwErrorCode setSelection (VARIANT vIDArray);
1034
1035
1045
1046
1055 EwErrorCode setActionRemoveWireCableCore (VARIANT_BOOL bActionRemove);
1056
1057
1066 VARIANT_BOOL getActionRemoveBridges (EwErrorCode* errorCode);
1067
1068
1077 EwErrorCode setActionRemoveBridges (VARIANT_BOOL bActionRemove);
1078
1079
1088
1089
1098
1099
1108
1109};
EwNumberWireAction
All the possible actions for renumber wires.
Definition: EnumDefinition.idl:298
EwSelectionType
All the selection types.
Definition: EnumDefinition.idl:313
EwErrorCode
All errors codes for this API.
Definition: EnumDefinition.idl:24
EwObjectType
Enum which contains all kind of object.
Definition: EwEnumeration.idl:889
EwEventCode
Events leading to snapshot.
Definition: EwEnumeration.idl:847
EwAutoArrowActionType
Enum which contains all action for the origin destination automatic insertion.
Definition: EwEnumeration.idl:933
EwProjectDataActionType
Action type to update or replace data in project.
Definition: EwEnumeration.idl:861
EwNumberMarkAction
All the possible actions for renumber marks.
Definition: EwEnumeration.idl:945
EwAutoArrowMarkType
Enum which contains marks type that we want to be aware for the origin destination automatic insertio...
Definition: EwEnumeration.idl:922
EwWireDirType
All the cabling direction.
Definition: EwEnumeration.idl:957
EwAutoArrowLocConnectType
Enum which contains all connection types related with the file location for the Origin Destination au...
Definition: EwEnumeration.idl:910
EwProjectDataObjectType
Type of object to update or replace data in project.
Definition: EwEnumeration.idl:874
Use this interface to manage the Origin Destination automatic insertion.
Definition: EwProjectProcessObjects.idl:625
EwErrorCode setDestinationSymbol(BSTR strBlockName)
Set the block name of symbol used for destination symbol.
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.
EwSelectionType getSelectionType(EwErrorCode *errorCode)
Return the EwSelectionType enum to specify the type of selection to use.
EwErrorCode setEquipotentialConnectionType(EwAutoArrowMarkType eAutomaticArrowMarkType)
Set the the EwAutoArrowMarkType enum to specify the equipotential connection with mark.
EwErrorCode setSelectionType(EwSelectionType eSelectionType)
Set the EwSelectionType enum to specify the type of selection to use.
EwErrorCode setLocationConnectionType(EwAutoArrowLocConnectType eAutomaticArrowLocConnectionType)
Set the EwAutoArrowLocConnectType enum to specify the connection type relate with the file location f...
VARIANT getSelection(EwErrorCode *errorCode)
Return the array of ID used to specify the selection of objects to include in Origin Destination auto...
EwErrorCode process(EwAutoArrowActionType eAutomaticArrowActionType)
Process function to insert Origin Destination automatic arrows in the current project.
EwErrorCode setSelection(VARIANT vIDArray)
Set the array of ID according to selection type.
BSTR getDestinationSymbol(EwErrorCode *errorCode)
Get the block name of symbol used for destination symbol.
EwErrorCode setActionOnManual(VARIANT_BOOL bActionOnManual)
Set this value to true if the action should be done on the Manual arrows.
EwAutoArrowLocConnectType getLocationConnectionType(EwErrorCode *errorCode)
Return the EwAutoArrowLocConnectType enum to specify the connection type relate with the file locatio...
BSTR getOriginSymbol(EwErrorCode *errorCode)
Get the block name of symbol used for origin symbol.
EwAutoArrowMarkType getEquipotentialConnectionType(EwErrorCode *errorCode)
Return the EwAutoArrowMarkType enum to specify the equipotential connection with mark.
Use this interface to manage the renumber documents.
Definition: EwProjectProcessObjects.idl:808
VARIANT_BOOL getActionOnManualNumber(EwErrorCode *errorCode)
Return true if the action should be done on the Manual marks.
EwErrorCode setFirstNumber(EwSelectionType eSelection, int iFirstNumber)
Set the first number for one selection enum.
int getIncrement(EwSelectionType eSelection, EwErrorCode *errorCode)
Get the increment for one selection enum.
int getFirstNumber(EwSelectionType eSelection, EwErrorCode *errorCode)
Get the first number for one selection enum.
VARIANT getSelection(EwErrorCode *errorCode)
Return the array of ID used to specify the selection of objects to include in renumbering process.
EwErrorCode process(EwNumberMarkAction eNumberAction)
Process function to renumber marks in the current project.
EwErrorCode setSelection(VARIANT vIDArray)
Set the array of ID according to selection type.
EwErrorCode setSelectionType(EwSelectionType eSelectionType)
Set the EwSelectionType enum to specify the type of selection to use.
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.
EwSelectionType getSelectionType(EwErrorCode *errorCode)
Return the EwSelectionType enum to specify the type of selection to use.
Use this interface to manage the renumber marks.
Definition: EwProjectProcessObjects.idl:445
EwErrorCode setActionOnManualNumber(VARIANT_BOOL bActionOnManualNumber)
Set this value to true if the action should be done on the Manual marks.
EwErrorCode setSelection(VARIANT vIDArray)
Set the array of identifiers of selected objects.
VARIANT getSelection(EwErrorCode *errorCode)
Return the array of identifiers used to specify the selection of objects to include in renumbering pr...
EwErrorCode process(EwNumberMarkAction eNumberAction)
Process function to renumber marks in the current project.
EwErrorCode addNumberObjectType(EwObjectType eNumberObjectType)
Add the EwObjectType enum to specify the type of object to apply.
long getNumberObjectType(EwErrorCode *errorCode)
Return the combination of EwObjectType enum to specify the type of objects to apply.
EwErrorCode setStartNumber(EwObjectType eObjectType, int iStartNumber)
Set the start number for one selection enum.
VARIANT_BOOL getActionOnManualNumber(EwErrorCode *errorCode)
Return true if the action should be done on the Manual marks.
EwErrorCode setStepIncrement(EwObjectType eObjectType, int iIncrement)
Set the step increment for one object type.
int getStartNumber(EwObjectType eObjectType, EwErrorCode *errorCode)
Get the start number for one object type.
int getStepIncrement(EwObjectType eObjectType, EwErrorCode *errorCode)
Get the step increment for one object type.
EwErrorCode setNumberObjectType(long lNumberObjectType)
Set the EwObjectType enum to specify the type of object to apply.
Use this interface to manage the numbering or renumbering of wires.
Definition: EwProjectProcessObjects.idl:330
EwErrorCode process(EwNumberWireAction eEwNumberAction)
Process function to number or renumber wires in the current project.
VARIANT_BOOL getActionOnManualNumber(EwErrorCode *errorCode)
Return true if the action should be done on the Manual number.
EwSelectionType getSelectionType(EwErrorCode *errorCode)
Return the EwSelectionType enum to specify the type of selection to use.
VARIANT getSelection(EwErrorCode *errorCode)
Return the array of ID used to specify the selection of objects to include in renumbering process.
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 setResetPosition(VARIANT_BOOL bResetPosition)
Set this value to true to reset the position of wire marks.
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.
Use this interface to manage the optimize wire order.
Definition: EwProjectProcessObjects.idl:969
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.
EwErrorCode setActionRemoveWireCableCore(VARIANT_BOOL bActionRemove)
Set this value to true if the action should be to remove the cable core association.
EwErrorCode setSelection(VARIANT vIDArray)
Set the array of ID according to selection type.
VARIANT_BOOL getActionOnManual(EwErrorCode *errorCode)
Return true if the action should be done on the Manual wire cabling order.
EwSelectionType getSelectionType(EwErrorCode *errorCode)
Return the EwSelectionType enum to specify the type of selection to use.
EwErrorCode setActionRemoveBridges(VARIANT_BOOL bActionRemove)
Set this value to true if the action should be to remove bridges.
VARIANT_BOOL getActionRemoveBridges(EwErrorCode *errorCode)
Return true if the action should be to remove bridges.
EwErrorCode setWireDirectionType(EwWireDirType eWireDirectionType)
Set the EwWireDirectionType enum to specify the cabling direction.
VARIANT getSelection(EwErrorCode *errorCode)
Return the array of ID used to specify the selection of objects to process.
EwErrorCode process()
Process function to optimize wire order in the current project.
EwErrorCode setSelectionType(EwSelectionType eSelectionType)
Set the EwSelectionType enum to specify the type of selection to use.
EwWireDirType getWireDirectionType(EwErrorCode *errorCode)
Return the EwWireDirectionType enum to specify the cabling direction.
Use this interface to manage snapshot manager inside a project.
Definition: EwProjectProcessObjects.idl:223
IEwProjectSnapshotX at(int iIndex, EwErrorCode *errorCode)
Return an IEwProjectSnapshotX object from the associated project.
IEwProjectSnapshotX findProjectSnapshotByID(LONG lId, EwErrorCode *errorCode)
Return an IEwProjectSnapshotX object by id .
LONG getCount(EwErrorCode *errorCode)
Return the number of snapshot of associated project.
IEwProjectSnapshotX newEwProjectSnapshot(EwErrorCode *errorCode)
Create an IEwProjectSnapshotX object from the associated project.
Use this interface to manage snapshot inside a project.
Definition: EwProjectProcessObjects.idl:24
EwErrorCode setGenerateAutomatedDrawings(VARIANT_BOOL bGenerateAutomatedDrawings)
Option to update all generated files like Terminal strips or Reports which have been added to the pro...
long getFileSize(EwErrorCode *errorCode)
Get the estimate file size in MB of this snapshot.
EwEventCode getEventType(EwErrorCode *errorCode)
Get the event type of this snapshot.
EwErrorCode update()
Update the object inside the current project.
BSTR getName(EwErrorCode *errorCode)
Get the name of this snapshot.
EwErrorCode setName(BSTR strName)
Set the name of this snapshot.
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.
BSTR getEventDetails(EwErrorCode *errorCode)
Get the event details of this snapshot.
BSTR getDescription(BSTR strLanguage, EwErrorCode *errorCode)
Get the description associated to the object.
EwErrorCode setDescription(BSTR strLanguage, BSTR strDescription)
Set the description associated to the object.
DATE getCreationDate(EwErrorCode *errorCode)
Get the creation date of this snapshot object.
EwErrorCode restore()
Restore a snapshot of the current project.
Use this interface to manage the update of project data from libraries.
Definition: EwProjectProcessObjects.idl:284
EwErrorCode addProjectDataObjectType(EwProjectDataObjectType eDataProjectObjectType)
Add the type of object to modify.
EwErrorCode process(EwProjectDataActionType eDataProjectActionType)
Process function to update or replace data in the current project.
EwErrorCode resetProjectDataObjectType()
Reset the type of object to modify.


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