Hide Table of Contents
SOLIDWORKS Electrical API  2020.0.5
Electrical API
EwProjectCableObjects.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 
12 import "EwObjectBase.idl";
13 
18 [
19  object,
20  uuid(60A0873B-AFFB-47CB-91B4-4F94D860672B),
21  dual,
22  nonextensible,
23  pointer_default(unique)
24 ]
25 interface IEwProjectCableX : IEwProjectTagObjectX
26 {
27 
28  /*
29  * Set the cable length value.
30  * \return EwErrorCode enum type, can be:
31  * \li EW_NO_ERROR if no error detected
32  * \li EW_UNDEFINED_ERROR if another error occurred
33  */
34  EwErrorCode setLength (DOUBLE dLength);
35 
36 
44  BSTR getArticleNumber (EwErrorCode* errorCode);
45 
46 
54  EwErrorCode setArticleNumber (BSTR strArticleNumber);
55 
56 
64  BSTR getManufacturer (EwErrorCode* errorCode);
65 
66 
74  BSTR getReference (EwErrorCode* errorCode);
75 
76 
85  LONG getCoreCount (EwErrorCode* errorCode);
86 
87 
88 
100  EwErrorCode setCoreStubs (LONG nCoreIdx, DOUBLE dStubLengthFrom, DOUBLE dStubLengthTo);
101 
102 
111  BSTR getExternalID (EwErrorCode* errorCode);
112 
113 
122  EwErrorCode setExternalID (BSTR strExternalID);
123 
124 
133  BSTR getLinearMass (EwErrorCode* errorCode);
134 
135 
145  EwErrorCode setLinearMass (BSTR strLinearMass);
146 
147 
148 };
149 
154 [
155  object,
156  uuid(5E7EE771-FFA6-4959-B3A6-09E8FED6F813),
157  dual,
158  nonextensible,
159  pointer_default(unique)
160 ]
161 interface IEwProjectCableManagerX : IDispatch{
170  IEwProjectCableX findEwProjectCableByID (LONG lCableID, EwErrorCode* errorCode);
171 
172 
177  IEwProjectCableX newEwProjectCable ();
178 
179 
187  VARIANT getEwProjectCableArray (EwErrorCode* errorCode);
188 
189 
197  LONG getCount (EwErrorCode* errorCode);
198 
199 
208  VARIANT selectCables (EwErrorCode* errorCode);
209 
210 };
IEwProjectCableManagerX::getEwProjectCableArray
VARIANT getEwProjectCableArray(EwErrorCode *errorCode)
Get all the cables in the manager project.
IEwProjectCableManagerX
Use this interface to manage cables of a project.
Definition: EwProjectCableObjects.idl:161
IEwProjectCableManagerX::findEwProjectCableByID
IEwProjectCableX findEwProjectCableByID(LONG lCableID, EwErrorCode *errorCode)
Find a cable in the project with the target ID.
IEwProjectTagObjectX
Generic interface for an object that belongs to a project.
Definition: EwObjectBase.idl:76
EwErrorCode
EwErrorCode
All errors codes for this API.
Definition: EnumDefinition.idl:21
IEwProjectCableX::setLength
EwErrorCode setLength(DOUBLE dLength)
IEwProjectCableX::setLinearMass
EwErrorCode setLinearMass(BSTR strLinearMass)
Set the linear mass (density) of this cable.
IEwProjectCableX::getLinearMass
BSTR getLinearMass(EwErrorCode *errorCode)
Get the linear mass (density) of this cable.
IEwProjectCableX::getReference
BSTR getReference(EwErrorCode *errorCode)
Get the reference of the cable.
IEwProjectCableX::getArticleNumber
BSTR getArticleNumber(EwErrorCode *errorCode)
Get the article number.
IEwProjectCableManagerX::newEwProjectCable
IEwProjectCableX newEwProjectCable()
Create an IEwProjectCableX object from the associated project.
IEwProjectCableX
Use this interface to manage a cable inside a project.
Definition: EwProjectCableObjects.idl:26
IEwProjectCableX::getCoreCount
LONG getCoreCount(EwErrorCode *errorCode)
Get cable core count.
IEwProjectCableX::getExternalID
BSTR getExternalID(EwErrorCode *errorCode)
Get external identifier of this cable.
IEwProjectCableManagerX::getCount
LONG getCount(EwErrorCode *errorCode)
return the number of cables of associated project
IEwProjectCableX::getManufacturer
BSTR getManufacturer(EwErrorCode *errorCode)
Get the manufacturer of the cable.
IEwProjectCableX::setExternalID
EwErrorCode setExternalID(BSTR strExternalID)
Set the external identifier of this cable.
IEwProjectCableManagerX::selectCables
VARIANT selectCables(EwErrorCode *errorCode)
Invoke cable selection dialog.
IEwProjectCableX::setArticleNumber
EwErrorCode setArticleNumber(BSTR strArticleNumber)
Set the article number.
IEwProjectCableX::setCoreStubs
EwErrorCode setCoreStubs(LONG nCoreIdx, DOUBLE dStubLengthFrom, DOUBLE dStubLengthTo)
Set lengths of cable core stubs.
Generated on Tue Sep 1 2020 17:01:22 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/EwProjectCableObjects.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) 2020 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