Hide Table of Contents
SOLIDWORKS Electrical API  2021.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 
73  BSTR get3DPartFilePath (EwErrorCode* errorCode);
74 
75 
83  BSTR getReference (EwErrorCode* errorCode);
84 
85 
93  BSTR getManufacturer (EwErrorCode* errorCode);
94 
95 
104  BSTR getDescription (BSTR strLanguageCode, EwErrorCode* errorCode);
105 
106 
111  LONG getClassificationID ();
112 
113 
121  VARIANT_BOOL isRailOrDuct (EwErrorCode* errorCode);
122 
123 
131  DOUBLE getWidth (EwErrorCode* errorCode);
132 
133 
141  DOUBLE getHeight (EwErrorCode* errorCode);
142 
143 
151  DOUBLE getDepth (EwErrorCode* errorCode);
152 
153 
161  DOUBLE getLength (EwErrorCode* errorCode);
162 
163 
171  DOUBLE getAdjustableLength (EwErrorCode* errorCode);
172 
173 
181  LONG getEwProjectManufacturerPartCircuitCount (EwErrorCode* errorCode);
182 
183 
191  IEwProjectComponentX getEwProjectComponent (EwErrorCode* errorCode);
192 
193 
201  IEwProjectLocationX getEwProjectLocation (EwErrorCode* errorCode);
202 
203 
204  /*
205  * \return Get the ID of the object. -1 if the object is invalid
206  */
207  LONG getID ();
208 
209 
220  EwErrorCode setUserData (LONG nUserDataNumber, BSTR strValue);
221 
222 
233  BSTR getUserData (LONG nUserDataNumber, EwErrorCode* errorCode);
234 
235 
248  EwErrorCode setTranslatedData (LONG nUserDataNumber, BSTR strLanguage, BSTR strValue);
249 
250 
262  BSTR getTranslatedData (LONG nUserDataNumber, BSTR strLanguage, EwErrorCode* errorCode);
263 
264 
272  BSTR getArticleNumber (EwErrorCode* errorCode);
273 
274 
282  EwErrorCode setArticleNumber (BSTR strArticleNumber);
283 
284 
285  /*
286  * Insert the manufacturer part inside the current project
287  * \return EwErrorCode enum type, can be:
288  * \li EW_NO_ERROR if no error detected
289  * \li EW_UNDEFINED_ERROR if another error occurred
290  * \li EW_INSERTION_FAILED if the insertion failed
291  * \li EW_OBJECT_ALREADY_INSERTED if this object already exists
292  */
293  EwErrorCode insert ();
294 
295 
296  /*
297  * Remove the manufacturer part from the current project
298  * \return EwErrorCode enum type, can be:
299  * \li EW_NO_ERROR if no error detected
300  * \li EW_UNDEFINED_ERROR if another error occurred
301  */
302  EwErrorCode remove ();
303 
304 
305  /*
306  * Update the Manufacturer part inside the current project
307  * \return EwErrorCode enum type, can be:
308  * \li EW_NO_ERROR if no error detected
309  * \li EW_UNDEFINED_ERROR if another error occurred
310  */
311  EwErrorCode update ();
312 
313 
323  BSTR getExternalID (EwErrorCode* errorCode);
324 
325 
335  EwErrorCode setExternalID (BSTR strExternalID);
336 
337 
347  VARIANT_BOOL getExcludeFromBillOfMaterials (EwErrorCode* errorCode);
348 
349 
359  EwErrorCode setExcludeFromBillOfMaterials (VARIANT_BOOL bIsExcludeFromBOM);
360 
361 
371  long getObjectID (EwErrorCode* errorCode);
372 
373 
385  EwErrorCode setObjectID (long lID);
386 
387 
401  EwErrorCode setHarnessID (long lHarnessID);
402 
403 
413  LONG getHarnessID (EwErrorCode* errorCode);
414 
415 };
416 
421 [
422  object,
423  uuid(b1162e20-26cd-11e5-b345-feff819cdc9f),
424  dual,
425  oleautomation,
426  nonextensible,
427  helpstring("IEwProjectManufacturerPartManagerX Interface"),
428  pointer_default(unique)
429 ]
430 interface IEwProjectManufacturerPartManagerX : IDispatch{
434  LONG getCount ();
435 
436 
441  IEwProjectManufacturerPartX newEwProjectManufacturerPart ();
442 
443 
452  IEwProjectManufacturerPartX findEwProjectManufacturerPartByID (LONG lID, EwErrorCode* errorCode);
453 
454 
460  VARIANT getEwProjectManufacturerPartArray (EwErrorCode* errorCode);
461 
462 };
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:430
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:297
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::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.
Generated on Thu Aug 20 2020 08:40:14 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) 2021 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.46