 |
SOLIDWORKS Electrical API
2020.0.5
Electrical API
|
Go to the documentation of this file.
4 midl_pragma warning(disable:2111)
10 import "EnumDefinition.idl";
11 import "EwProjectRoutingObjects.idl";
12 import "EwProjectComponentObjects.idl";
13 import "EwProjectManufacturerPartObjects.idl";
14 import "EwProjectLocationObjects.idl";
15 import "EwProjectWireObjects.idl";
16 import "EwProjectCableObjects.idl";
17 import "EwProjectEntity3DObjects.idl";
18 import "EwProjectHarnessObjects.idl";
19 import "EwProjectExportObjects.idl";
20 import "EwProjectProcessObjects.idl";
43 uuid(B13AD024-81E0-41C8-ADCA-518E347AAAE9),
47 helpstring(
"IEwProjectSymbolX Interface"),
48 pointer_default(unique)
318 uuid(06DD51E2-79F7-4148-9F53-02932E9A2D44),
322 pointer_default(unique)
346 uuid(4ac92b54-1043-11e5-9493-1697f925ec7b),
350 helpstring(
"IEwProjectFileX Interface"),
351 pointer_default(unique)
583 uuid(5C9A9148-129E-4FCC-AE6A-842C0F78C736),
586 helpstring(
"IEwProjectBookX Interface"),
587 pointer_default(unique)
600 uuid(743809C9-28AA-409F-B8F3-50907C2B68EC),
603 helpstring(
"IEwProjectFunctionX Interface"),
604 pointer_default(unique)
627 uuid(BEBE7B8F-F07A-4F7B-B931-B206E6587E76),
631 helpstring(
"IEwProjectFileManagerX Interface"),
632 pointer_default(unique)
713 uuid(4227D81E-E027-43CF-89C4-D877A885BBB1),
717 helpstring(
"IEwProjectConfigurationX Interface"),
718 pointer_default(unique)
782 uuid(F984331D-9550-492C-9804-C43D9A173CA1),
785 pointer_default(unique)
839 uuid(41B046AD-FD19-4184-B6E7-A67E80FFD48F),
842 pointer_default(unique)
896 uuid(10D11ED8-FB45-4A3E-ADF6-DC349B4ECBFF),
899 helpstring(
"IEwProjectFolder Interface"),
900 pointer_default(unique)
1015 uuid(85158F93-1205-4614-ABC3-F3F19F9EDCDD),
1018 pointer_default(unique)
1072 uuid(9442A4C0-D96C-4AAE-B679-C76877753635),
1076 helpstring(
"IEwProjectX Interface"),
1077 pointer_default(unique)
1786 uuid(9A02A344-94BB-4F95-A133-45E09A42D6C5),
1790 helpstring(
"IEwProjectManagerX Interface"),
1791 pointer_default(unique)
1902 uuid(9fd7cb1e-5e41-4e5b-91c4-825a6494819a),
1903 helpstring(
"Event interface for EwProjectX")
BSTR getFolderPath(EwProjectFolderPathValue eProjectFolderPathValue, EwErrorCode *errorCode)
Return folder path associated to the current project.
LONG getPosition(EwErrorCode *errorCode)
Get the position of files inside a book/folder.
EwOpenProjectMode
All possible open modes for a project.
Definition: EwEnumeration.idl:434
EwErrorCode setGenerateAutomatedDrawings(VARIANT_BOOL bGenerateAutomatedDrawings)
Option to update all generated files like Terminal strips or Reports which have been added to the pro...
EwErrorCode unlock()
Unlock the file.
EwErrorCode setObjectID(long lID)
Sets the Object associated with the symbol.
VARIANT getEwProjectFileArray(EwErrorCode *errorCode)
Return the array of IEwProjectFile of associated project.
IEwProjectFolderX newEwProjectFolder(EwErrorCode *errorCode)
Create a IEwProjectFolderX object from the associated project.
IEwProjectFunctionManagerX getEwProjectFunctionManager(EwErrorCode *errorCode)
Get an IEwProjectFunctionManagerX to manage Functions of this project.
Definition: EwProjectObjects.idl:1906
Use this interface to manage cables of a project.
Definition: EwProjectCableObjects.idl:161
BSTR getCustomerName(EwErrorCode *errorCode)
Get the name of the customer of the project.
double getXScale(EwErrorCode *errorCode)
Return the X scale of the symbol.
IEwProjectBookManagerX getEwProjectBookManager(EwErrorCode *errorCode)
Get an IEwProjectBookManagerX to manage Books of this project.
long getObjectID(EwErrorCode *errorCode)
Return the Object ID associated with the symbol.
EwFileType
File types used in a project.
Definition: EwEnumeration.idl:352
Generic interface for an object that belongs to a project.
Definition: EwObjectBase.idl:76
EwErrorCode setRotationAngle(double dAngle)
Set the rotation angle in degrees of the symbol.
Use this interface to manage IEwProjectX objects.
Definition: EwProjectObjects.idl:1793
EwProjectConfigValue
Values for project configuration.
Definition: EwEnumeration.idl:101
long getFileID(EwErrorCode *errorCode)
Return the file ID containing the symbol.
EwErrorCode setEwProjectFolderID(LONG lID)
Set the folder ID as parent for this file.
BSTR getCurrentCodeLanguage(EwErrorCode *errorCode)
BSTR getAssociatedMacro(EwErrorCode *errorCode)
Return the associated macro of the symbol.
LONG getEwProjectFolderID(EwErrorCode *errorCode)
Get the ID of the folder containing this file.
Use this interface to manage IEwProjectManufacturerPartX objects.
Definition: EwProjectManufacturerPartObjects.idl:350
Use this interface to manage the export reports used inside the project.
Definition: EwProjectExportObjects.idl:986
long getLocationID(EwErrorCode *errorCode)
Return the Location ID of the symbol.
EwErrorCode setFirstDrawingNumber(LONG lID)
Set the number of the first drawing that will be created in this folder.
BSTR getModifiedBy(EwErrorCode *eErrorCode)
Get the last user name that modified the current object.
Use this interface to manage export DWG files inside a project.
Definition: EwProjectExportObjects.idl:648
INT_PTR getCount(EwErrorCode *errorCode)
Return the number of Folders of associated project.
IEwProjectSymbolManagerX getEwProjectSymbolManager(EwErrorCode *pErrorCode)
Get an IEwProjectSymbolManagerX to manage ProjectSymbolManager of this project.
IEwProjectX findEwProjectByName(BSTR strName, EwErrorCode *errorCode)
Look for the first project from a name.
Use this interface to manage the update of project data from libraries.
Definition: EwProjectProcessObjects.idl:242
EwErrorCode setEwProjectBookID(LONG lID)
Update the ID of the book containing this folder.
EwErrorCode close()
close the project
IEwProjectHarnessManagerX getEwProjectHarnessManager(EwErrorCode *errorCode)
Get an IEwProjectHarnessManagerX to manage Harness of this project.
IEwProjectBookX newEwProjectBook(EwErrorCode *errorCode)
Create a IEwProjectBookX object from the associated project.
IEwProjectLocationX getEwProjectLocation(EwErrorCode *errorCode)
IEwProjectLocationX associated with the file.
EwErrorCode archive(VARIANT projectIDArray, BSTR strFilePath, VARIANT_BOOL bWithDependencies)
Archive projects.
EwErrorCode
All errors codes for this API.
Definition: EnumDefinition.idl:21
INT_PTR getCount(EwErrorCode *errorCode)
Return the number of Functions of associated project.
Use this interface to manage for reports used inside the project.
Definition: EwProjectExportObjects.idl:916
BSTR getCustomerAddress1(EwErrorCode *errorCode)
Get the customer address 1 of the project.
BSTR getCreoFolderPath(EwErrorCode *errorCode)
Return Creo folder path where Creo files are stored.
EwErrorCode setYScale(double dYScale)
Sets the Y scale of the symbol.
Use this interface to manage a print configuration manager inside a project.
Definition: EwProjectExportObjects.idl:513
LONG getEwProjectFolderID(EwErrorCode *errorCode)
Get the ID of the folder containing this folder.
IEwProjectComponentManagerX getEwProjectComponentManager(EwErrorCode *errorCode)
Get an IEwProjectComponentManagerX to manage components of this project.
IEwProjectUpdateReplaceDataX getEwProjectUpdateData(EwErrorCode *errorCode)
Get an IEwProjectUpdateReplaceDataX to manage the update or replacedata of this project.
BSTR getCustomerAddress2(EwErrorCode *errorCode)
Get the customer address 2 of the project.
double getRotationAngle(EwErrorCode *errorCode)
Return the rotation angle in degrees of the symbol.
EwSymbolCrossRefType getEwSymbolCrossRefType(EwErrorCode *errorCode)
Return the cross reference type of the symbol.
EwErrorCode setUserData(LONG nUserDataNumber, BSTR strValue)
Set user data of the object Project must be opened to be able to call this method.
EwMeasurementType
All measurement type.
Definition: EwEnumeration.idl:252
IEwProjectSymbolX getProjectSymbolByID(LONG lId, EwErrorCode *pErrorCode)
return a Project Symbol by id.
EwErrorCode setDrawingOfficeName(BSTR strValue)
Set the Drawing office name of the project.
VARIANT_BOOL getDefineFirstDrawingNumber(EwErrorCode *errorCode)
Return true if the number of the first drawing created in the folder have to be the one defined in se...
BSTR getCustomerAddress3(EwErrorCode *errorCode)
Get the customer address 3 of the project.
EwErrorCode setCustomerName(BSTR strValue)
Set the name of the customer of the project.
BSTR getCabinetLayoutTitleBlock()
IEwProjectReportManagerX getEwProjectReportManager(EwErrorCode *errorCode)
Get an IEwProjectReportManagerX to manage reports of this project.
Use this interface to manage the Harness objects inside a project.
Definition: EwProjectHarnessObjects.idl:44
Use this interface to manage the numbering or renumbering of wires.
Definition: EwProjectProcessObjects.idl:289
IEwProjectExportDWGFilesX newEwProjectExportDWGFiles(EwErrorCode *errorCode)
Create an IEwProjectExportDWGFilesX object from the associated project.
LONG getEwProjectBookID(EwErrorCode *errorCode)
Get the ID of the book containing this folder.
void updateItemNotity(IDispatch *IEwObjectX)
this methode is an project Event of api when an item as update to project the event is fire
EwErrorCode setCustomerAddress3(BSTR strValue)
Set the customer address 3 of the project.
BSTR getRowMark(EwErrorCode *errorCode)
Return the row mark of the symbol.
Use this interface to manage IEwProjectBookX objects.
Definition: EwProjectObjects.idl:788
Use this interface to manage IEwProjectSymbolManagerX objects.
Definition: EwProjectObjects.idl:325
EwProjectFolderPathValue
Used with getFolderPath of EwProjectX object.
Definition: EwEnumeration.idl:42
BSTR getFilePath(EwErrorCode *errorCode)
Return the file path.
IEwProjectFileX findEwProjectFileByID(LONG lEwProjectFileID, EwErrorCode *errorCode)
Get the EwProjectFile from the file ID, for associated project.
Use this interface to manage IEwProjectFunctionX objects.
Definition: EwProjectObjects.idl:845
EwErrorCode setExternID(BSTR strValue)
Set the externID field in the project.
This interface is a generic interface for standard methods.
Definition: EwObjectBase.idl:26
VARIANT getEwProjectConfigValue(EwProjectConfigValue ewProjectConfigurationValues, EwErrorCode *errorCode)
IEwProjectAutomaticArrowsX newEwProjectAutomaticArrows(EwErrorCode *errorCode)
Create an IEwProjectAutomaticArrowsX to manage the Origin Destination automatic insertion.
VARIANT getEwProjectArray(EwErrorCode *errorCode)
Return the array of IEwProjectX.
LONG getFirstDrawingNumber(EwErrorCode *errorCode)
Get the number of the first drawing that will be created in this folder.
DATE getModificationDate(EwErrorCode *errorCode)
Get the modification date of the project.
IEwProjectFolderX findEwProjectFolderByID(LONG lEwProjectFolderID, EwErrorCode *errorCode)
Get the EwProjectFolder from the Folder ID of associated project.
IEwProjectOptimizeWireOrderX newEwProjectOptimizeWireOrder(EwErrorCode *errorCode)
Create an IEwProjectOptimizeWireOrderX to optimize the wire order of this project.
VARIANT getEwProjectFolderArray(EwErrorCode *errorCode)
Return the array of IEwProjectFolder of associated project.
Use this interface to manage symbol inside a project.
Definition: EwProjectObjects.idl:51
IEwProjectGenerateTSDrawingX newEwProjectGenerateTSDrawing(EwErrorCode *errorCode)
Create an IEwProjectGenerateTSDrawingX object to draw terminal strip in a project.
IEwProjectFunctionX findEwProjectFunctionByID(LONG lEwProjectFunctionID, EwErrorCode *errorCode)
Get the EwProjectFunction from the Function ID, for associated project.
EwErrorCode lock()
Lock the file so no one connected to the collaborative server can edit or delete it.
IEwProjectX findProjectFromFilePath(BSTR strFilePath, EwErrorCode *errorCode)
Return an IEwProjectX from a file path.
EwErrorCode setDrawingOfficeAddress2(BSTR strValue)
Set the drawing office address 2 of the project.
EwErrorCode setXPosition(double dXCoordinate)
Sets the X coordinate of the symbol.
VARIANT getEwProjectFunctionArray(EwErrorCode *errorCode)
Return the array of IEwProjectFunction of associated project.
EwErrorCode setDefineFirstDrawingNumber(VARIANT_BOOL bDefineFirstDrawingNumber)
Set this value to true to have the number of the first drawing created in this folder initialised by ...
EwErrorCode close()
Close the project file.
BSTR getDrawingOfficeName(EwErrorCode *errorCode)
Get the drawing office name of the project.
IEwProjectNumberMarksX newEwProjectNumberMarks(EwErrorCode *errorCode)
Create an IEwProjectNumberMarksX to manage the renumbering marks of this project.
EwSymbolType
All types of symbol.
Definition: EwEnumeration.idl:392
EwErrorCode setYPosition(double dYCoordinate)
Sets the Y coordinate of the symbol.
Use this interface to manage the location objects inside a project.
Definition: EwProjectLocationObjects.idl:65
EwErrorCode setCustomerAddress2(BSTR strValue)
Set the customer address 2 of the project.
BSTR getContractNumber(EwErrorCode *errorCode)
Get the contract number of the project.
EwMeasurementType getEwMeasurementType(EwErrorCode *errorCode)
Return the measurement type of the symbol.
Use this interface to manage configuration of the project.
Definition: EwProjectObjects.idl:721
double getYPosition(EwErrorCode *errorCode)
Return the Y coordinate of the symbol.
BSTR getDrawingOfficeAddress1(EwErrorCode *errorCode)
Get the drawing office address 1 of the project.
EwErrorCode setContractNumber(BSTR strValue)
Set the contract number of the project.
Use this interface to manage the renumber marks.
Definition: EwProjectProcessObjects.idl:404
IEwProjectPrintConfigManagerX getEwProjectPrintConfigManager(EwErrorCode *errorCode)
Get an IEwProjectPrintConfigManagerX to manage print config of this project.
long getManufacturerPartID(EwErrorCode *errorCode)
Return the ManufacturerPart ID associated with the symbol.
EwSymbolCrossRefType
All cross reference type of symbol.
Definition: EwEnumeration.idl:419
LONG getEwProjectBookID(EwErrorCode *errorCode)
Get the ID of the book containing this file.
IEwProjectFileX newProjectFile(EwErrorCode *errorCode)
Create an IEwProjectFileX in the current project.
Use this interface to manage snapshot manager inside a project.
Definition: EwProjectProcessObjects.idl:181
EwSymbolType getEwSymbolType(EwErrorCode *errorCode)
Return the type of the symbol.
EwMeasurementType getEwMeasurementType(EwErrorCode *errorCode)
EwErrorCode setFileType(EwFileType eFileType)
Set the file type of the current project file.
EwErrorCode setEwMeasurementType(EwMeasurementType ewMeasurementType)
Set the measurement type of the symbol.
Use this interface to manage the generation of terminal strip drawing inside the project.
Definition: EwProjectExportObjects.idl:1315
Use this interface to manage a project.
Definition: EwProjectObjects.idl:1079
LONG getPosition(EwErrorCode *errorCode)
Get the position of the folder in the book.
IEwProjectFileX findEwProjectFileFromPath(BSTR strFilePath, EwErrorCode *errorCode)
Get the EwProjectFile from a file path.
EwErrorCode setEwProjectBookID(LONG lID)
Set the Book ID of this file.
BSTR getDrawingOfficeAddress2(EwErrorCode *errorCode)
Get the drawing office address 2 of the project.
void addItemNotify(IDispatch *IEwObjectX)
/** this methode is an project Event of api when an item as add to project the event is fire
Use this interface to manage the components inside a project.
Definition: EwProjectComponentObjects.idl:178
Use this interface to manage IEwProjectWireX objects.
Definition: EwProjectWireObjects.idl:207
IEwProjectFolderManagerX getEwProjectFolderManager(EwErrorCode *errorCode)
Get an IEwProjectFolderManagerX to manage Folders of this project.
IEwProjectWireManagerX getEwProjectWireManager(EwErrorCode *errorCode)
To get the project wire manager.
EwErrorCode setCustomerAddress1(BSTR strValue)
Set the customer address 1 of the project.
Use this interface to manage the location inside a project.
Definition: EwProjectLocationObjects.idl:27
Use this interface to manage the Origin Destination automatic insertion.
Definition: EwProjectProcessObjects.idl:480
BSTR getTargetFilePath(EwErrorCode *errorCode)
Return the path to a file not only a reference to a *.lnk.
EwErrorCode setEwSymbolName(BSTR strSymbolName)
Sets the symbol name of the symbol.
EwErrorCode setTranslatedData(LONG nUserDataNumber, BSTR strLanguage, BSTR strValue)
Set the value of a translated text Project must be opened to be able to call this method.
EwErrorCode setName(BSTR strValue)
Set the name of the project.
IEwProjectSnapshotManagerX getEwProjectSnapshotManager(EwErrorCode *errorCode)
Get an IEwProjectSnapshotManagerX to manage snapshots of this project.
IEwProjectFunctionX newEwProjectFunction(EwErrorCode *errorCode)
Create a IEwProjectFunctionX object from the associated project.
Use this interface to manage function inside a project.
Definition: EwProjectObjects.idl:607
void deleteItemNotify(IDispatch *IEwObjectX)
this methode is an project Event of api when an item as delete to project the event is fire
EwErrorCode setDrawingOfficeAddress3(BSTR strValue)
Set the drawing office address 3 of the project.
IEwProjectNumberDocumentsX newEwProjectNumberDocumments(EwErrorCode *errorCode)
Create an IEwProjectNumberDocumentsX to manage the renumbering document marks of this project.
Use this interface to manage folder inside a project.
Definition: EwProjectObjects.idl:903
Use this interface to manage the renumber documents.
Definition: EwProjectProcessObjects.idl:663
BSTR getTranslatedData(LONG nUserDataNumber, BSTR strLanguage, EwErrorCode *errorCode)
Get the value of a translated text.
IEwRoutingDataX getEwRoutingData(EwErrorCode *errorCode)
To get the routing data manager.
BSTR getUserData(LONG nUserDataNumber, EwErrorCode *errorCode)
Get user data of the object Project must be opened to be able to call this method.
EwErrorCode open()
Open the project file.
IEwProjectLocationManagerX getEwProjectLocationManager(EwErrorCode *errorCode)
Get an IEwProjectLocationManagerX to manage locations of this project.
double getYScale(EwErrorCode *errorCode)
Return the Y scale of the symbol.
INT_PTR getCount(EwErrorCode *errorCode)
Return the number of books of associated project.
IEwProjectFileManagerX getEwProjectFileManager(EwErrorCode *errorCode)
Get an IEwProjectFileManagerX to manage files of this project.
EwErrorCode open(EwOpenProjectMode eOpenMode)
open the project
Use this interface to manage file inside a project.
Definition: EwProjectObjects.idl:354
Use this interface to manage IEwProjectFolderX objects.
Definition: EwProjectObjects.idl:1021
BSTR getTagPath(EwErrorCode *errorCode)
Get the tag path of this Function.
IEwProjectExportPDMX newEwProjectExportPDM(EwErrorCode *errorCode)
Create an IEwProjectExportPDMX object from the associated project.
VARIANT getEwProjectBookArray(EwErrorCode *errorCode)
Return the array of IEwProjectBook of associated project.
IEwProjectManufacturerPartManagerX getEwProjectManufacturerPartManager(EwErrorCode *errorCode)
Get an IEwProjectManufacturerPartManagerX to manage Builds of Materials of this project.
EwErrorCode setEwProjectFolderID(LONG lID)
Update the folder ID of the parent folder.
IEwProjectX findEwProjectByID(LONG lId, EwErrorCode *errorCode)
Look for a project from an ID.
BSTR getName(EwErrorCode *errorCode)
Get the name of the project.
EwErrorCode setDrawingOfficeAddress1(BSTR strValue)
Set the drawing office address 1 of the project.
BSTR getColumnMark(EwErrorCode *errorCode)
Return the column mark of the symbol.
IEwProjectBookX findEwProjectBookByID(LONG lEwProjectBookID, EwErrorCode *errorCode)
Get the EwProjectBook from the book ID, for associated project.
INT_PTR getCount(EwErrorCode *errorCode)
Return the number of files of associated project.
IEwProjectNumberWiresX newEwProjectNumberWires(EwErrorCode *errorCode)
Create an IEwProjectNumberWiresX to manage the numbering or the renumbering wires of this project.
long getFunctionID(EwErrorCode *errorCode)
Return the Function ID to the symbol.
VARIANT getEwProjectFileArrayFromFileType(EwFileType eFileType, EwErrorCode *errorCode)
Return the array of IEwProjectFileX of given type for associated project.
EwErrorCode setEwProjectConfigValue(EwProjectConfigValue ewProjectConfigurationValues, VARIANT value)
VARIANT unarchive(BSTR strFilePath, VARIANT_BOOL bWithDependencies, EwErrorCode *errorCode)
Unarchive projects.
BSTR getExternID(EwErrorCode *errorCode)
Get the externID of the project.
EwErrorCode setOriginalFilePath(BSTR strFilePath, VARIANT_BOOL asShortCut)
Specify the path of the file to add in the project.
IEwProjectCableManagerX getEwProjectCableManager(EwErrorCode *errorCode)
To get the cable manager.
BSTR getDrawingOfficeAddress3(EwErrorCode *errorCode)
Get the drawing office address 3 of the project.
IEwProjectExportReportX newEwProjectExportReport(EwErrorCode *errorCode)
Create an IEwProjectExportReportX object from the associated project.
VARIANT_BOOL getGenerateAutomatedDrawings(EwErrorCode *errorCode)
Option to update all generated files like Terminal strips or Reports which have been added to the pro...
IEwProjectConfigurationX getEwProjectConfiguration(EwErrorCode *errorCode)
To get the project configuration.
VARIANT getMacroVariables(EwErrorCode *errorCode)
Get an array of strings of the automation variables of the project, usually a macro.
Use this interface to manage the command "Export to PDM".
Definition: EwProjectExportObjects.idl:752
Use this interface to manage book inside a project.
Definition: EwProjectObjects.idl:590
Use this interface to manage EwProjectFileManagerx objects.
Definition: EwProjectObjects.idl:634
EwErrorCode setXScale(double dXScale)
Sets the X scale of the symbol.
VARIANT_BOOL isOpen(EwErrorCode *errorCode)
Return true if the project file is open.
double getXPosition(EwErrorCode *errorCode)
Return the X coordinate of the symbol.
Use this interface to manage the optimize wire order.
Definition: EwProjectProcessObjects.idl:821
BSTR getEwSymbolName(EwErrorCode *errorCode)
Return the symbol name of the symbol in the library.