Hide Table of Contents
SOLIDWORKS Electrical API  2022.0.0
Electrical API
EwProjectManufacturerPartObjects.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 "EnumDefinition.idl";
11 import "EwProjectLocationObjects.idl";
12 import "EwProjectComponentObjects.idl";
13 
18 [
19  object,
20  uuid(70792A44-0983-467D-9D9D-76465608CAAD),
21  dual,
22  oleautomation,
23  nonextensible,
24  helpstring("EwProjectManufacturerPartCircuitX Interface"),
25  pointer_default(unique)
26 ]
27 interface IEwProjectManufacturerPartCircuitX : IDispatch{
28 
29 };
30 
35 [
36  object,
37  uuid(CE2D9B08-6AEB-494C-BE28-6672CC3E4821),
38  dual,
39  oleautomation,
40  nonextensible,
41  helpstring("IEwProjectManufacturerPartTerminalX Interface"),
42  pointer_default(unique)
43 ]
44 interface IEwProjectManufacturerPartTerminalX : IDispatch{
45 
46 };
47 
48 
53 [
54  object,
55  uuid(1EB3362A-D37A-4E2A-8ED6-D6BB4FCC0CA3),
56  dual,
57  oleautomation,
58  nonextensible,
59  helpstring("IEwProjectManufacturerPartX Interface"),
60  pointer_default(unique)
61 ]
62 interface IEwProjectManufacturerPartX : IDispatch{
63 
64 
65 
74  BSTR get3DPartFilePath (EwErrorCode* errorCode);
75 
76 
85  BSTR getReference (EwErrorCode* errorCode);
86 
87 
96  BSTR getManufacturer (EwErrorCode* errorCode);
97 
98 
108  BSTR getDescription (BSTR strLanguageCode, EwErrorCode* errorCode);
109 
110 
115  LONG getClassificationID ();
116 
117 
126  VARIANT_BOOL isRailOrDuct (EwErrorCode* errorCode);
127 
128 
137  DOUBLE getWidth (EwErrorCode* errorCode);
138 
139 
148  DOUBLE getHeight (EwErrorCode* errorCode);
149 
150 
159  DOUBLE getDepth (EwErrorCode* errorCode);
160 
161 
170  DOUBLE getLength (EwErrorCode* errorCode);
171 
172 
181  DOUBLE getAdjustableLength (EwErrorCode* errorCode);
182 
183 
192  LONG getEwProjectManufacturerPartCircuitCount (EwErrorCode* errorCode);
193 
194 
203  IEwProjectComponentX getEwProjectComponent (EwErrorCode* errorCode);
204 
205 
214  IEwProjectLocationX getEwProjectLocation (EwErrorCode* errorCode);
215 
216 
217  /*
218  * \return Get the ID of the object. -1 if the object is invalid
219  */
220  LONG getID ();
221 
222 
234  EwErrorCode setUserData (LONG nUserDataNumber, BSTR strValue);
235 
236 
248  BSTR getUserData (LONG nUserDataNumber, EwErrorCode* errorCode);
249 
250 
264  EwErrorCode setTranslatedData (LONG nUserDataNumber, BSTR strLanguage, BSTR strValue);
265 
266 
279  BSTR getTranslatedData (LONG nUserDataNumber, BSTR strLanguage, EwErrorCode* errorCode);
280 
281 
290  BSTR getArticleNumber (EwErrorCode* errorCode);
291 
292 
301  EwErrorCode setArticleNumber (BSTR strArticleNumber);
302 
303 
304  /*
305  * Insert the manufacturer part inside the current project
306  * \return EwErrorCode enum type, can be:
307  * \li EW_NO_ERROR if no error detected
308  * \li EW_UNDEFINED_ERROR if another error occurred
309  * \li EW_INSERTION_FAILED if the insertion failed
310  * \li EW_OBJECT_ALREADY_INSERTED if this object already exists
311  * \li EW_INVALID_OBJECT if object is not initialized
312  */
313  EwErrorCode insert ();
314 
315 
316  /*
317  * Remove the manufacturer part from the current project
318  * \return EwErrorCode enum type, can be:
319  * \li EW_NO_ERROR if no error detected
320  * \li EW_UNDEFINED_ERROR if another error occurred
321  * \li EW_INVALID_OBJECT if object is not initialized
322  */
323  EwErrorCode remove ();
324 
325 
326  /*
327  * Update the Manufacturer part inside the current project
328  * \return EwErrorCode enum type, can be:
329  * \li EW_NO_ERROR if no error detected
330  * \li EW_UNDEFINED_ERROR if another error occurred
331  * \li EW_INVALID_OBJECT if object is not initialized
332  */
333  EwErrorCode update ();
334 
335 
345  BSTR getExternalID (EwErrorCode* errorCode);
346 
347 
357  EwErrorCode setExternalID (BSTR strExternalID);
358 
359 
369  VARIANT_BOOL getExcludeFromBillOfMaterials (EwErrorCode* errorCode);
370 
371 
381  EwErrorCode setExcludeFromBillOfMaterials (VARIANT_BOOL bIsExcludeFromBOM);
382 
383 
393  long getObjectID (EwErrorCode* errorCode);
394 
395 
407  EwErrorCode setObjectID (long lID);
408 
409 
423  EwErrorCode setHarnessID (long lHarnessID);
424 
425 
435  LONG getHarnessID (EwErrorCode* errorCode);
436 
437 
448  IEwClassificationX getClassification (EwErrorCode* errorCode);
449 
450 
461  EwErrorCode setClassificationID (long lClassificationID);
462 
463 };
464 
469 [
470  object,
471  uuid(b1162e20-26cd-11e5-b345-feff819cdc9f),
472  dual,
473  oleautomation,
474  nonextensible,
475  helpstring("IEwProjectManufacturerPartManagerX Interface"),
476  pointer_default(unique)
477 ]
478 interface IEwProjectManufacturerPartManagerX : IDispatch{
482  LONG getCount ();
483 
484 
489  IEwProjectManufacturerPartX newEwProjectManufacturerPart ();
490 
491 
500  IEwProjectManufacturerPartX findEwProjectManufacturerPartByID (LONG lID, EwErrorCode* errorCode);
501 
502 
508  VARIANT getEwProjectManufacturerPartArray (EwErrorCode* errorCode);
509 
510 };
IEwProjectManufacturerPartX::getAdjustableLength
DOUBLE getAdjustableLength(EwErrorCode *errorCode)
Get the adjustable length of the manufacturer part.
IEwProjectManufacturerPartManagerX
Use this interface to manage IEwProjectManufacturerPartX objects.
Definition: EwProjectManufacturerPartObjects.idl:478
IEwProjectManufacturerPartX::getManufacturer
BSTR getManufacturer(EwErrorCode *errorCode)
Get the manufacturer's name.
EwErrorCode
EwErrorCode
All errors codes for this API.
Definition: EnumDefinition.idl:21
IEwProjectManufacturerPartManagerX::newEwProjectManufacturerPart
IEwProjectManufacturerPartX newEwProjectManufacturerPart()
Create a IEwProjectManufacturerPartX object from the associated project.
IEwProjectManufacturerPartX::setExternalID
EwErrorCode setExternalID(BSTR strExternalID)
Set the external identifier.
IEwProjectManufacturerPartX::getDescription
BSTR getDescription(BSTR strLanguageCode, EwErrorCode *errorCode)
Get the manufacturer part description.
IEwProjectManufacturerPartX::getExcludeFromBillOfMaterials
VARIANT_BOOL getExcludeFromBillOfMaterials(EwErrorCode *errorCode)
Check if current manufacturer part is to exclude from bill of materials.
IEwProjectManufacturerPartX::getHarnessID
LONG getHarnessID(EwErrorCode *errorCode)
Get the Harness ID associated with the manufacturer part.
IEwProjectManufacturerPartTerminalX
Use this interface to manage manufacturer part terminal inside a project.
Definition: EwProjectManufacturerPartObjects.idl:44
IEwProjectManufacturerPartCircuitX
Use this interface to manage manufacturer part circuit inside a project.
Definition: EwProjectManufacturerPartObjects.idl:27
IEwProjectManufacturerPartX::getEwProjectManufacturerPartCircuitCount
LONG getEwProjectManufacturerPartCircuitCount(EwErrorCode *errorCode)
Get the number of circuits associated to the manufacturer part.
IEwProjectManufacturerPartX::getEwProjectLocation
IEwProjectLocationX getEwProjectLocation(EwErrorCode *errorCode)
Get the location to which the manufacturer part is associated.
IEwProjectManufacturerPartX::get3DPartFilePath
BSTR get3DPartFilePath(EwErrorCode *errorCode)
Get the file path of the associated 3D part.
IEwProjectManufacturerPartX::setUserData
EwErrorCode setUserData(LONG nUserDataNumber, BSTR strValue)
Set user data of the object Project must be opened to be able to call this method.
IEwProjectManufacturerPartX::getExternalID
BSTR getExternalID(EwErrorCode *errorCode)
Get external identifier.
IEwProjectManufacturerPartX::setArticleNumber
EwErrorCode setArticleNumber(BSTR strArticleNumber)
Set the value of a translated text.
IEwProjectComponentX
Use this interface to manage a component inside a project.
Definition: EwProjectComponentObjects.idl:298
IEwProjectManufacturerPartX::getDepth
DOUBLE getDepth(EwErrorCode *errorCode)
Get the depth of the manufacturer part.
IEwProjectLocationX
Use this interface to manage the location inside a project.
Definition: EwProjectLocationObjects.idl:27
IEwProjectManufacturerPartX::getEwProjectComponent
IEwProjectComponentX getEwProjectComponent(EwErrorCode *errorCode)
Get the component to which the manufacturer part is associated.
IEwProjectManufacturerPartX::getHeight
DOUBLE getHeight(EwErrorCode *errorCode)
Get the height of the manufacturer part.
IEwProjectManufacturerPartX::getArticleNumber
BSTR getArticleNumber(EwErrorCode *errorCode)
Get the value of a translated text.
IEwProjectManufacturerPartManagerX::getEwProjectManufacturerPartArray
VARIANT getEwProjectManufacturerPartArray(EwErrorCode *errorCode)
Get all the manufacturer parts in the manager project.
IEwProjectManufacturerPartX::getObjectID
long getObjectID(EwErrorCode *errorCode)
Return the Object ID associated with the manufacturer part.
IEwProjectManufacturerPartX::isRailOrDuct
VARIANT_BOOL isRailOrDuct(EwErrorCode *errorCode)
Check if the manufacturer part is a rail or a duct.
IEwProjectManufacturerPartX::getUserData
BSTR getUserData(LONG nUserDataNumber, EwErrorCode *errorCode)
Get user data of the object Project must be opened to be able to call this method.
IEwProjectManufacturerPartX::setHarnessID
EwErrorCode setHarnessID(long lHarnessID)
Set the Harness ID of this manufacturer part.
IEwProjectManufacturerPartX::getClassification
IEwClassificationX getClassification(EwErrorCode *errorCode)
Get the classification of the current manufacturer part.
IEwProjectManufacturerPartX::getClassificationID
LONG getClassificationID()
Get the classification ID of the manufacturer part.
IEwProjectManufacturerPartManagerX::findEwProjectManufacturerPartByID
IEwProjectManufacturerPartX findEwProjectManufacturerPartByID(LONG lID, EwErrorCode *errorCode)
return a Manufacturer part according to an ID
IEwProjectManufacturerPartX::getWidth
DOUBLE getWidth(EwErrorCode *errorCode)
Get the width of the manufacturer part.
IEwProjectManufacturerPartX::setTranslatedData
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.
IEwProjectManufacturerPartX::getLength
DOUBLE getLength(EwErrorCode *errorCode)
Get the length of the manufacturer part.
IEwProjectManufacturerPartX
Use this interface to manage manufacturer part inside a project.
Definition: EwProjectManufacturerPartObjects.idl:62
IEwProjectManufacturerPartX::setExcludeFromBillOfMaterials
EwErrorCode setExcludeFromBillOfMaterials(VARIANT_BOOL bIsExcludeFromBOM)
Set if current manufacturer part is to exclude from bill of materials.
IEwProjectManufacturerPartX::getReference
BSTR getReference(EwErrorCode *errorCode)
Get the reference name of this manufacturer part.
IEwProjectManufacturerPartX::getTranslatedData
BSTR getTranslatedData(LONG nUserDataNumber, BSTR strLanguage, EwErrorCode *errorCode)
Get the value of a translated text.
IEwProjectManufacturerPartX::setObjectID
EwErrorCode setObjectID(long lID)
Sets the ID of the object to associate with the manufacturer part.
IEwProjectManufacturerPartX::setClassificationID
EwErrorCode setClassificationID(long lClassificationID)
Set the setClassification of the current manufacturer part by classification id.
Generated on Wed Aug 18 2021 10:34:10 for SOLIDWORKS Electrical API by   doxygen 1.8.18


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

0.20.21