Hide Table of Contents
SOLIDWORKS Electrical API 2024.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
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]
190interface 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]
251interface IEwProjectUpdateReplaceDataX : IDispatch
252{
263
264
273
274
284
285};
286
291[
292 object,
293 uuid(A166A78B-30A4-4A18-92F3-5F0B26C6B03E),
294 dual,
295 nonextensible,
296 pointer_default(unique)
297]
298interface 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]
413interface IEwProjectNumberMarksX : IDispatch
414{
423 VARIANT_BOOL getActionOnManualNumber (EwErrorCode* errorCode);
424
425
434 EwErrorCode setActionOnManualNumber (VARIANT_BOOL bActionOnManualNumber);
435
436
445
446
455
456
464 EwErrorCode setNumberObjectType (long lNumberObjectType);
465
466
475 VARIANT getSelection (EwErrorCode* errorCode);
476
477
486 EwErrorCode setSelection (VARIANT vIDArray);
487
488
504 int getStartNumber (EwObjectType eObjectType, EwErrorCode* errorCode);
505
506
523 EwErrorCode setStartNumber (EwObjectType eObjectType, int iStartNumber);
524
525
545 int getStepIncrement (EwObjectType eObjectType, EwErrorCode* errorCode);
546
547
567 EwErrorCode setStepIncrement (EwObjectType eObjectType, int iIncrement);
568
569
579
580};
581
586[
587 object,
588 uuid(BACCE4FF-4ACC-4BB4-8573-FF8399EECEBA),
589 dual,
590 nonextensible,
591 pointer_default(unique)
592]
593interface IEwProjectAutomaticArrowsX : IDispatch
594{
603 VARIANT_BOOL getActionOnManual (EwErrorCode* errorCode);
604
605
614 EwErrorCode setActionOnManual (VARIANT_BOOL bActionOnManual);
615
616
625
626
636
637
644 VARIANT getSelection (EwErrorCode* errorCode);
645
646
658 EwErrorCode setSelection (VARIANT vIDArray);
659
660
669 BSTR getOriginSymbol (EwErrorCode* errorCode);
670
671
681 EwErrorCode setOriginSymbol (BSTR strBlockName);
682
683
693
694
705
706
716
717
727
728
738
739
749
750
760 EwErrorCode process (EwAutoArrowActionType eAutomaticArrowActionType);
761
762};
763
764
769[
770 object,
771 uuid(91474E70-76FC-4816-8405-8AFF3975C0C6),
772 dual,
773 nonextensible,
774 pointer_default(unique)
775]
776interface IEwProjectNumberDocumentsX : IDispatch
777{
786 VARIANT_BOOL getActionOnManualNumber (EwErrorCode* errorCode);
787
788
797 EwErrorCode setActionOnManualNumber (VARIANT_BOOL bActionOnManualNumber);
798
799
808
809
819
820
827 VARIANT getSelection (EwErrorCode* errorCode);
828
829
841 EwErrorCode setSelection (VARIANT vIDArray);
842
843
858 int getFirstNumber (EwSelectionType eSelection, EwErrorCode* errorCode);
859
860
876 EwErrorCode setFirstNumber (EwSelectionType eSelection, int iFirstNumber);
877
878
892 int getIncrement (EwSelectionType eSelection, EwErrorCode* errorCode);
893
894
910 EwErrorCode setIncrement (EwSelectionType eSelection, int iIncrement);
911
912
913
923
924};
925
930[
931 object,
932 uuid(B62B5A84-7357-4A80-8E27-CF0A5332F734),
933 dual,
934 nonextensible,
935 pointer_default(unique)
936]
937interface IEwProjectOptimizeWireOrderX : IDispatch
938{
947 VARIANT_BOOL getActionOnManual (EwErrorCode* errorCode);
948
949
958 EwErrorCode setActionOnManual (VARIANT_BOOL bActionOnManual);
959
960
969
970
980
981
988 VARIANT getSelection (EwErrorCode* errorCode);
989
990
1002 EwErrorCode setSelection (VARIANT vIDArray);
1003
1004
1014
1015
1024 EwErrorCode setActionRemoveWireCableCore (VARIANT_BOOL bActionRemove);
1025
1026
1035 VARIANT_BOOL getActionRemoveBridges (EwErrorCode* errorCode);
1036
1037
1046 EwErrorCode setActionRemoveBridges (VARIANT_BOOL bActionRemove);
1047
1048
1057
1058
1067
1068
1077
1078};
EwNumberWireAction
All the possible actions for renumber wires.
Definition: EnumDefinition.idl:294
EwSelectionType
All the selection types.
Definition: EnumDefinition.idl:309
EwErrorCode
All errors codes for this API.
Definition: EnumDefinition.idl:24
EwObjectType
Enum which contains all kind of object.
Definition: EwEnumeration.idl:871
EwEventCode
Events leading to snapshot.
Definition: EwEnumeration.idl:829
EwAutoArrowActionType
Enum which contains all action for the origin destination automatic insertion.
Definition: EwEnumeration.idl:915
EwProjectDataActionType
Action type to update or replace data in project.
Definition: EwEnumeration.idl:843
EwNumberMarkAction
All the possible actions for renumber marks.
Definition: EwEnumeration.idl:927
EwAutoArrowMarkType
Enum which contains marks type that we want to be aware for the origin destination automatic insertio...
Definition: EwEnumeration.idl:904
EwWireDirType
All the cabling direction.
Definition: EwEnumeration.idl:939
EwAutoArrowLocConnectType
Enum which contains all connection types related with the file location for the Origin Destination au...
Definition: EwEnumeration.idl:892
EwProjectDataObjectType
Type of object to update or replace data in project.
Definition: EwEnumeration.idl:856
Use this interface to manage the Origin Destination automatic insertion.
Definition: EwProjectProcessObjects.idl:594
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:777
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:414
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:299
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:938
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:191
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.
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:252
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) 2024 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.