Hide Table of Contents
SOLIDWORKS Electrical API 2023.0.0
Electrical API
EwProjectManufacturerPartObjects.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 "EnumDefinition.idl";
11import "EwProjectLocationObjects.idl";
12import "EwProjectComponentObjects.idl";
13import "EwSymbolObjects.idl";
14import "EwTerminalObjects.idl";
15
20[
21 object,
22 uuid(70792A44-0983-467D-9D9D-76465608CAAD),
23 dual,
24 oleautomation,
25 nonextensible,
26 helpstring("EwProjectManufacturerPartCircuitX Interface"),
27 pointer_default(unique)
28]
30
31};
32
37[
38 object,
39 uuid(CE2D9B08-6AEB-494C-BE28-6672CC3E4821),
40 dual,
41 oleautomation,
42 nonextensible,
43 helpstring("IEwProjectManufacturerPartTerminalX Interface"),
44 pointer_default(unique)
45]
47
48};
49
50
55[
56 object,
57 uuid(1EB3362A-D37A-4E2A-8ED6-D6BB4FCC0CA3),
58 dual,
59 oleautomation,
60 nonextensible,
61 helpstring("IEwProjectManufacturerPartX Interface"),
62 pointer_default(unique)
63]
65{
75 EwErrorCode setUserData (LONG nUserDataNumber , BSTR strValue);
76
77
87 BSTR getUserData (LONG nUserDataNumber , EwErrorCode* errorCode);
88
89
101 EwErrorCode setTranslatedData (LONG nUserDataNumber , BSTR strLanguage, BSTR strValue);
102
103
115 BSTR getTranslatedData (LONG nUserDataNumber , BSTR strLanguage, EwErrorCode* errorCode);
116
117
118
128
129
138 BSTR getReference (EwErrorCode* errorCode);
139
140
151 EwErrorCode setReference (BSTR strReference);
152
153
162 BSTR getManufacturer (EwErrorCode* errorCode);
163
164
175 EwErrorCode setManufacturer (BSTR strManufacturerName);
176
177
187 BSTR getSeries (EwErrorCode* errorCode);
188
189
200 EwErrorCode setSeries (BSTR strSeries);
201
202
213
214
226 EwErrorCode setDataSheetFilePath (BSTR strDataSheetFilePath);
227
228
238 BSTR getSupplierName (EwErrorCode* errorCode);
239
240
251 EwErrorCode setSupplierName (BSTR strSupplierName);
252
253
263 BSTR getStockNumber (EwErrorCode* errorCode);
264
265
276 EwErrorCode setStockNumber (BSTR strStockNumber);
277
278
289 BSTR getDescription (BSTR strLanguageCode, EwErrorCode* errorCode);
290
291
303 EwErrorCode setDescription (BSTR strLanguageCode, BSTR strDescription);
304
305
312
313
322 VARIANT_BOOL isRailOrDuct (EwErrorCode* errorCode);
323
324
333 DOUBLE getWidth (EwErrorCode* errorCode);
334
335
346 EwErrorCode setWidth (DOUBLE dWidth);
347
348
357 DOUBLE getHeight (EwErrorCode* errorCode);
358
359
370 EwErrorCode setHeight (DOUBLE dHeight);
371
372
381 DOUBLE getDepth (EwErrorCode* errorCode);
382
383
394 EwErrorCode setDepth (DOUBLE dDepth);
395
396
405 DOUBLE getLength (EwErrorCode* errorCode);
406
407
418 EwErrorCode setLength (DOUBLE dLength);
419
420
429 DOUBLE getAdjustableLength (EwErrorCode* errorCode);
430
431
441
442
453
454
464
465
476
477
486 BSTR getArticleNumber (EwErrorCode* errorCode);
487
488
498 EwErrorCode setArticleNumber (BSTR strArticleNumber);
499
500
510 BSTR getExternalID (EwErrorCode* errorCode);
511
512
522 EwErrorCode setExternalID (BSTR strExternalID);
523
524
535
536
546 EwErrorCode setExcludeFromBillOfMaterials (VARIANT_BOOL bIsExcludeFromBOM);
547
548
558 long getObjectID (EwErrorCode* errorCode);
559
560
573
574
588 EwErrorCode setHarnessID (long lHarnessID);
589
590
601 LONG getHarnessID (EwErrorCode* errorCode);
602
603
615
616
627 EwErrorCode setClassificationID (long lClassificationID);
628
629
640 EwErrorCode setWeight (DOUBLE dWeight);
641
642
652 DOUBLE getWeight (EwErrorCode* errorCode);
653
654
666 LONG getClassID (EwErrorCode* errorCode);
667
668
680
681
692
693
704
705
717
718
731
732
744
745
758
759
771
772
785
786
798
799
812
813
825
826
839
840
852
853
866
867
877 BSTR getUseVoltage (EwErrorCode* errorCode);
878
879
890 EwErrorCode setUseVoltage (BSTR strUseVoltage);
891
892
902 BSTR getUseFrequency (EwErrorCode* errorCode);
903
904
915 EwErrorCode setUseFrequency (BSTR strUseFrequency);
916
917
928
929
940 EwErrorCode setControlVoltage (BSTR strControlVoltage);
941
942
953
954
965 EwErrorCode setControlFrequency (BSTR strControlFrequency);
966
967
981
982
995 EwErrorCode setManufacturerDataValue (EwManufacturerDataIndex eIndexValue, BSTR strManufacturerDataValue);
996
997
998};
999
1004[
1005 object,
1006 uuid(b1162e20-26cd-11e5-b345-feff819cdc9f),
1007 dual,
1008 oleautomation,
1009 nonextensible,
1010 helpstring("IEwProjectManufacturerPartManagerX Interface"),
1011 pointer_default(unique)
1012]
1017 LONG getCount ();
1018
1019
1025
1026
1036
1037
1044
1045};
EwManufacturerDataIndex
Enumeration of the manufacturer data indexes.
Definition: EnumDefinition.idl:459
EwErrorCode
All errors codes for this API.
Definition: EnumDefinition.idl:21
EwManufacturerPartType
Manufacturer part type.
Definition: EwEnumeration.idl:664
Use this interface to manage an IEwClassificationX object.
Definition: EwClassificationObjects.idl:214
This interface is a generic interface for standard object methods.
Definition: EwObjectBaseObjects.idl:97
Use this interface to manage a component inside a project.
Definition: EwProjectComponentObjects.idl:522
Use this interface to manage the location inside a project.
Definition: EwProjectLocationObjects.idl:27
Use this interface to manage manufacturer part circuit inside a project.
Definition: EwProjectManufacturerPartObjects.idl:29
Use this interface to manage IEwProjectManufacturerPartX objects.
Definition: EwProjectManufacturerPartObjects.idl:1013
IEwProjectManufacturerPartX findEwProjectManufacturerPartByID(LONG lID, EwErrorCode *errorCode)
return a Manufacturer part according to an ID
IEwProjectManufacturerPartX newEwProjectManufacturerPart()
Create a IEwProjectManufacturerPartX object from the associated project.
VARIANT getEwProjectManufacturerPartArray(EwErrorCode *errorCode)
Get all the manufacturer parts in the manager project.
Use this interface to manage manufacturer part terminal inside a project.
Definition: EwProjectManufacturerPartObjects.idl:46
Use this interface to manage manufacturer part inside a project.
Definition: EwProjectManufacturerPartObjects.idl:65
DOUBLE getLength(EwErrorCode *errorCode)
Get the length in millimeters of the manufacturer part.
long getTerminalTypeID(EwErrorCode *errorCode)
Get the terminal type ID of the current manufacturer part.
long getSchemeSymbolID(EwErrorCode *errorCode)
Get the schematic symbol ID of the current manufacturer part.
BSTR getDescription(BSTR strLanguageCode, EwErrorCode *errorCode)
Get the manufacturer part description.
EwErrorCode setDataSheetFilePath(BSTR strDataSheetFilePath)
Set the data sheet file path of the current manufacturer part.
BSTR getManufacturerDataValue(EwManufacturerDataIndex eIndexValue, EwErrorCode *errorCode)
Get a manufacturer data value associated to the current manufacturer part.
BSTR getUseVoltage(EwErrorCode *errorCode)
Get the use voltage of the current manufacturer part.
LONG getHarnessID(EwErrorCode *errorCode)
Get the Harness ID associated with the manufacturer part.
EwErrorCode setTerminalTypeID(long lID)
Set the terminal type ID of the current manufacturer part.
BSTR getDataSheetFilePath(EwErrorCode *errorCode)
Get the data sheet file path of the current manufacturer part.
BSTR getUseFrequency(EwErrorCode *errorCode)
Get the use frequency of the current manufacturer part.
EwErrorCode setExternalID(BSTR strExternalID)
Set the external identifier.
EwErrorCode setWeight(DOUBLE dWeight)
Set the weight of the current manufacturer part.
BSTR getControlVoltage(EwErrorCode *errorCode)
Get the control voltage of the current manufacturer part.
EwErrorCode setUserData(LONG nUserDataNumber, BSTR strValue)
Set user data of the object.
EwErrorCode setHarnessID(long lHarnessID)
Set the Harness ID of this manufacturer part.
EwErrorCode setTerminalStripSymbolID(long lID)
Set the terminal strip symbol ID of the current manufacturer part.
EwErrorCode setSupplierName(BSTR strSupplierName)
Set the supplier name of the current manufacturer part.
EwManufacturerPartType getEwManufacturerPartType(EwErrorCode *errorCode)
Get the base type (EwManufacturerPartType enum) of the current manufacturer part.
DOUBLE getWidth(EwErrorCode *errorCode)
Get the width in millimeters of the current manufacturer part.
EwErrorCode setControlFrequency(BSTR strControlFrequency)
Set the control frequency of the current manufacturer part.
EwErrorCode setSchemeSymbolID(long lID)
Set the schematic symbol ID of the current manufacturer part.
EwErrorCode setConnectionLabelSymbolID(long lID)
Set the connection label symbol ID of the current manufacturer part.
EwErrorCode setDepth(DOUBLE dDepth)
Set the depth in millimeters of the current manufacturer part.
VARIANT_BOOL isRailOrDuct(EwErrorCode *errorCode)
Check if the manufacturer part is a rail or a duct.
BSTR getExternalID(EwErrorCode *errorCode)
Get external identifier.
BSTR getSeries(EwErrorCode *errorCode)
Get the series of the current manufacturer part.
EwErrorCode setStockNumber(BSTR strStockNumber)
Set the stock number of the current manufacturer part.
BSTR getControlFrequency(EwErrorCode *errorCode)
Get the control frequency of the current manufacturer part.
EwErrorCode set2DFootPrintSymbolID(long lID)
Set the 2D foot print symbol ID of the current manufacturer part.
EwErrorCode setClassificationID(long lClassificationID)
Set the setClassification of the current manufacturer part by classification id.
BSTR getSupplierName(EwErrorCode *errorCode)
Get the supplier name of the current manufacturer part.
VARIANT_BOOL getExcludeFromBillOfMaterials(EwErrorCode *errorCode)
Check if current manufacturer part is to exclude from bill of materials.
EwErrorCode setControlVoltage(BSTR strControlVoltage)
Set the control voltage of the current manufacturer part.
BSTR getUserData(LONG nUserDataNumber, EwErrorCode *errorCode)
Get user data of the object.
IEwProjectLocationX getEwProjectLocation(EwErrorCode *errorCode)
Get the location to which the manufacturer part is associated.
EwErrorCode setUseVoltage(BSTR strUseVoltage)
Set the use voltage of the current manufacturer part.
DOUBLE getWeight(EwErrorCode *errorCode)
Get the weight in grams of the current manufacturer part.
long getObjectID(EwErrorCode *errorCode)
Return the Object ID associated with the manufacturer part.
BSTR getArticleNumber(EwErrorCode *errorCode)
Get article number of the object.
long get2DFootPrintSymbolID(EwErrorCode *errorCode)
Get the 2D foot print symbol ID of the current manufacturer part.
BSTR getStockNumber(EwErrorCode *errorCode)
Get the stock number of the current manufacturer part.
EwErrorCode setClassID(LONG lID)
Set the class ID of this manufacturer part.
BSTR get3DPartFilePath(EwErrorCode *errorCode)
Get the file path of the associated 3D part.
BSTR getReference(EwErrorCode *errorCode)
Get the reference name of this manufacturer part.
EwErrorCode setArticleNumber(BSTR strArticleNumber)
Set article number of the object.
IEwProjectComponentX getEwProjectComponent(EwErrorCode *errorCode)
Get the component to which the current manufacturer part is associated.
long getConnectionLabelSymbolID(EwErrorCode *errorCode)
Get the connection label symbol ID of the current manufacturer part.
EwErrorCode setDescription(BSTR strLanguageCode, BSTR strDescription)
Set the manufacturer part description.
EwErrorCode setEwManufacturerPartType(EwManufacturerPartType eManufacturerPartType)
Set the base type (EwManufacturerPartType enum) of the current manufacturer part.
EwErrorCode setSeries(BSTR strSeries)
Set the series of the current manufacturer part.
long getTerminalStripSymbolID(EwErrorCode *errorCode)
Get the terminal strip symbol ID of the current manufacturer part.
EwErrorCode setLineDiagramSymbolID(long lID)
Set the line diagram symbol ID of the current manufacturer part.
long getLineDiagramSymbolID(EwErrorCode *errorCode)
Get the line diagram symbol ID of the current manufacturer part.
DOUBLE getAdjustableLength(EwErrorCode *errorCode)
Get the adjustable length of the manufacturer part.
EwErrorCode setManufacturerDataValue(EwManufacturerDataIndex eIndexValue, BSTR strManufacturerDataValue)
Set a manufacturer data value associated to the current manufacturer part.
BSTR getManufacturer(EwErrorCode *errorCode)
Get the manufacturer name of the current manufacturer part.
EwErrorCode setHeight(DOUBLE dHeight)
Set the height in millimeters of the current manufacturer part.
IEwClassificationX getClassification(EwErrorCode *errorCode)
Get the classification of the current manufacturer part.
EwErrorCode setManufacturer(BSTR strManufacturerName)
Set the manufacturer name of the current manufacturer part.
EwErrorCode setObjectID(long lID)
Sets the ID of the object to associate with the manufacturer part.
EwErrorCode setExcludeFromBillOfMaterials(VARIANT_BOOL bIsExcludeFromBOM)
Set if current manufacturer part is to exclude from bill of materials.
BSTR getTranslatedData(LONG nUserDataNumber, BSTR strLanguage, EwErrorCode *errorCode)
Get the value of a translated text.
EwErrorCode setTranslatedData(LONG nUserDataNumber, BSTR strLanguage, BSTR strValue)
Set the value of a translated text.
DOUBLE getDepth(EwErrorCode *errorCode)
Get the depth in millimeters of the manufacturer part.
DOUBLE getHeight(EwErrorCode *errorCode)
Get the height in millimeters of the current manufacturer part.
LONG getClassID(EwErrorCode *errorCode)
Get the class ID of the manufacturer part.
EwErrorCode setUseFrequency(BSTR strUseFrequency)
Set the use frequency of the current manufacturer part.
LONG getEwProjectManufacturerPartCircuitCount(EwErrorCode *errorCode)
Get the number of circuits associated to the current manufacturer part.
LONG getEwProjectManufacturerPartTerminalCount(EwErrorCode *errorCode)
Get the number of terminals associated to the current manufacturer part.
LONG getClassificationID()
Deprecated use getClassId.
EwErrorCode setLength(DOUBLE dLength)
Set the length in millimeters of the current manufacturer part.
EwErrorCode setReference(BSTR strReference)
Set the reference name of this manufacturer part.
EwErrorCode setWidth(DOUBLE dWidth)
Set the width in millimeters of the current manufacturer part.


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/EwProjectManufacturerPartObjects.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) 2023 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.