Hide Table of Contents
SOLIDWORKS Electrical API  2020.0.5
Electrical API
EwProjectWireObjects.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 
8 import "oaidl.idl";
9 import "ocidl.idl";
10 
11 import "EnumDefinition.idl";
12 import "EwObjectBase.idl";
13 
14 
19 [
20  object,
21  uuid(61f18da4-03bd-11e5-8418-1697f925ec7b),
22  dual,
23  oleautomation,
24  nonextensible,
25  helpstring("IEwProjectWireX Interface"),
26  pointer_default(unique)
27 ]
28 interface IEwProjectWireX : IEwObjectBaseX
29 {
39  EwErrorCode setUserData (LONG nUserDataNumber , BSTR strValue);
40 
41 
51  BSTR getUserData (LONG nUserDataNumber , EwErrorCode* errorCode);
52 
53 
61  BSTR getTag (EwErrorCode* errorCode);
62 
63 
74  EwErrorCode setTag (BSTR strValue);
75 
76 
84  BSTR getTagRoot (EwErrorCode* errorCode);
85 
86 
95  EwErrorCode setTagRoot (BSTR strValue);
96 
97 
105  EwTagMode getTagMode (EwErrorCode* errorCode);
106 
107 
116  EwErrorCode setTagMode (EwTagMode eValue);
117 
118 
126  long getTagNumber (EwErrorCode* errorCode);
127 
128 
138  EwErrorCode setTagNumber (long lValue);
139 
140 
148  EwErrorCode setNextTagNumber ();
149 
150 
158  VARIANT_BOOL isTagUnique (EwErrorCode* errorCode);
159 
160 
161  /*
162  * Set the wire length value
163  * \return EwErrorCode enum type, can be:
164  * \li EW_NO_ERROR if no error detected
165  * \li EW_UNDEFINED_ERROR if another error occurred
166  */
167  EwErrorCode setLength (DOUBLE dLength);
168 
169 
178  BSTR getLinearMass (EwErrorCode* errorCode);
179 
180 
190  EwErrorCode setLinearMass (BSTR strLinearMass);
191 
192 
193 };
194 
195 
200 [
201  object,
202  uuid(FC6A488D-6EA7-4800-9035-2F7F4FEA6E61),
203  dual,
204  nonextensible,
205  pointer_default(unique)
206 ]
207 interface IEwProjectWireManagerX : IDispatch{
216  IEwProjectWireX findEwProjectWireByID (LONG lWireID, EwErrorCode* errorCode);
217 
218 
224  VARIANT getEwProjectWireArray (EwErrorCode* errorCode);
225 
226 
235  IEwProjectWireX newEwProjectWire (EwErrorCode* pErrorCode);
236 
237 };
IEwProjectWireX::setNextTagNumber
EwErrorCode setNextTagNumber()
Set the next number to have a unique mark.
IEwProjectWireX::getTagNumber
long getTagNumber(EwErrorCode *errorCode)
Get the mark number of this object.
IEwProjectWireX::isTagUnique
VARIANT_BOOL isTagUnique(EwErrorCode *errorCode)
Returns true or false if mark is unique.
IEwProjectWireManagerX::findEwProjectWireByID
IEwProjectWireX findEwProjectWireByID(LONG lWireID, EwErrorCode *errorCode)
Find a wire in the project with the target ID.
IEwProjectWireX::setLinearMass
EwErrorCode setLinearMass(BSTR strLinearMass)
Set the linear mass (density) of this wire.
IEwProjectWireX::setTag
EwErrorCode setTag(BSTR strValue)
Set the mark of this object.
EwErrorCode
EwErrorCode
All errors codes for this API.
Definition: EnumDefinition.idl:21
IEwProjectWireX::setUserData
EwErrorCode setUserData(LONG nUserDataNumber, BSTR strValue)
Set user data of the object.
IEwProjectWireManagerX::getEwProjectWireArray
VARIANT getEwProjectWireArray(EwErrorCode *errorCode)
Get all the wires in the project of the manager.
IEwProjectWireX::setTagNumber
EwErrorCode setTagNumber(long lValue)
Set the mark number of this object.
IEwObjectBaseX
This interface is a generic interface for standard methods.
Definition: EwObjectBase.idl:26
IEwProjectWireManagerX::newEwProjectWire
IEwProjectWireX newEwProjectWire(EwErrorCode *pErrorCode)
Create an interface for a new wire in the current project.
IEwProjectWireX::getLinearMass
BSTR getLinearMass(EwErrorCode *errorCode)
Get the linear mass (density) of this wire.
IEwProjectWireX::setTagRoot
EwErrorCode setTagRoot(BSTR strValue)
Set the mark root of this object.
EwTagMode
EwTagMode
All Mark mode type.
Definition: EwEnumeration.idl:739
IEwProjectWireManagerX
Use this interface to manage IEwProjectWireX objects.
Definition: EwProjectWireObjects.idl:207
IEwProjectWireX::setLength
EwErrorCode setLength(DOUBLE dLength)
IEwProjectWireX::getTag
BSTR getTag(EwErrorCode *errorCode)
Get the mark of this object.
IEwProjectWireX
Use this interface to manage wire inside a project.
Definition: EwProjectWireObjects.idl:29
IEwProjectWireX::getUserData
BSTR getUserData(LONG nUserDataNumber, EwErrorCode *errorCode)
Get user data of the object.
IEwProjectWireX::getTagMode
EwTagMode getTagMode(EwErrorCode *errorCode)
Get the mark mode of this object.
IEwProjectWireX::setTagMode
EwErrorCode setTagMode(EwTagMode eValue)
Set the mark mode of this object.
IEwProjectWireX::getTagRoot
BSTR getTagRoot(EwErrorCode *errorCode)
Get the mark root of this object.
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/EwProjectWireObjects.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.46