SOLIDWORKS Electrical API: idl_converted/EwProjectWireObjects.idl Source File - 2025

> SOLIDWORKS Electrical API: idl_converted/EwProjectWireObjects.idl Source File

Welcome

Getting Started

SOLIDWORKS API Help

SOLIDWORKS Electrical API Help

SOLIDWORKS PDM Professional API Help

PDM Pro API Web Service

FeatureWorks API Help

SOLIDWORKS Costing API Help

SOLIDWORKS Document Manager API Help

SOLIDWORKS Inspection API Help

SOLIDWORKS Routing API Help

SOLIDWORKS Simulation API Help

SOLIDWORKS Sustainability API Help

SOLIDWORKS Toolbox API Help

SOLIDWORKS Utilities API Help

SOLIDWORKS Visualize API Help

eDrawings API Help

DraftSight API Help

Lisp Programming Basics

Lisp Functions Overview

Lisp Functions Reference

Visual Lisp Compatible Functions

SOLIDWORKS Electrical API 2025.0.0

Electrical API

idl_converted

Go to the documentation of this file.

#pragma once
 
#if (__midl >= 501)
    midl_pragma warning(disable:2111) /* Disable warning MIDL2111 regarding identifier lengths exceeding 31 chars. */
#endif
 
import "oaidl.idl";
import "ocidl.idl";
import "EnumDefinition.idl";
import "EwObjectBaseObjects.idl";
import "EwProjectCableObjects.idl";
 
[
    object,
    uuid(61f18da4-03bd-11e5-8418-1697f925ec7b),
    dual,
    oleautomation,
    nonextensible,
    helpstring("IEwProjectWireX Interface"),
    pointer_default(unique)
]
interface IEwProjectWireX : IEwObjectX
{
    EwErrorCode setUserData (LONG nUserDataNumber,  BSTR strValue);
 
    BSTR  getUserData (LONG nUserDataNumber,  EwErrorCode* errorCode);
 
    BSTR getTag (EwErrorCode* errorCode);
 
    EwErrorCode setTag (BSTR strValue);
 
    BSTR getTagRoot (EwErrorCode* errorCode);
 
    EwErrorCode setTagRoot (BSTR strValue);
 
    EwTagMode getTagMode (EwErrorCode* errorCode);
 
    EwErrorCode setTagMode (EwTagMode eTagMode);
 
    long getTagNumber (EwErrorCode* errorCode);
 
    EwErrorCode setTagNumber (long lValue);
 
    EwErrorCode setNextTagNumber ();
 
    VARIANT_BOOL  isTagUnique (EwErrorCode* errorCode);
 
    /*
    * Set the wire length value.
    * \return EwErrorCode enum type, can be:
    * \li EW_UNDEFINED_ERROR if another error occurred
    * \li EW_INVALID_OBJECT if current object is invalid
    * \li EW_NO_ERROR if no error detected
    */
    EwErrorCode setLength (DOUBLE dLength);
 
    BSTR getLinearMass (EwErrorCode* errorCode);
 
    EwErrorCode setLinearMass (BSTR strLinearMass);
 
    EwErrorCode setHarnessID (long lHarnessID);
 
    LONG getHarnessID (EwErrorCode* errorCode);
 
    DOUBLE getLength (EwErrorCode* errorCode);
 
    EwErrorCode setDiameter (DOUBLE dValue);
 
    DOUBLE getDiameter (EwErrorCode* errorCode);
 
    EwErrorCode setSectionOrGauge (BSTR strValue);
 
    BSTR getSectionOrGauge (EwErrorCode* errorCode);
 
    EwErrorCode setWireSizeStandard (EwWireSizeStandard eWireSizeStandard);
 
    EwWireSizeStandard getWireSizeStandard (EwErrorCode* errorCode);
 
    EwErrorCode setSignal (BSTR strValue);
 
    BSTR getSignal (EwErrorCode* errorCode);
 
    BSTR getColorCode (EwErrorCode* errorCode);
 
    EwErrorCode setColorCode (BSTR strColorCode);
 
    EwErrorCode setBendRadiusFactor (DOUBLE dBendRadiusFactor);
 
    DOUBLE getBendRadiusFactor (EwErrorCode* errorCode);
 
    EwErrorCode setBendRadius (DOUBLE dBendRadius);
 
    DOUBLE getBendRadius (EwErrorCode* errorCode);
 
    BSTR getPath (EwErrorCode* errorCode);
 
    LONG getWireStyleID (EwErrorCode* errorCode);
 
    BSTR getEquipotential (EwErrorCode* errorCode);
 
    LONG getCableWireOrder (EwErrorCode* errorCode);
 
    LONG getCableID (EwErrorCode* errorCode);
 
    BSTR getOrigin (EwErrorCode* errorCode);
 
    BSTR getDestination (EwErrorCode* errorCode);
 
    BSTR getCableCoreDescription (EwErrorCode* errorCode);
 
    LONG getComponentID (EwWireExtremityType eWireExtremityType,  EwErrorCode* errorCode);
 
    LONG getOriginComponentID (EwErrorCode* errorCode);
 
    LONG getDestinationComponentID (EwErrorCode* errorCode);
 
    LONG getComponentCircuitID (EwWireExtremityType eWireExtremityType,  EwErrorCode* errorCode);
 
    LONG getOriginComponentCircuitID (EwErrorCode* errorCode);
 
    LONG getDestinationComponentCircuitID (EwErrorCode* errorCode);
 
    LONG getComponentTerminalNumber (EwWireExtremityType eWireExtremityType,  EwErrorCode* errorCode);
 
    LONG getOriginComponentTerminalNumber (EwErrorCode* errorCode);
 
    LONG getDestinationComponentTerminalNumber (EwErrorCode* errorCode);
 
    VARIANT_BOOL getIsFixedLength (EwErrorCode* errorCode);
 
    EwErrorCode setIsFixedLength (VARIANT_BOOL bIsFixedLength);
 
};
 
[
    object,
    uuid(FC6A488D-6EA7-4800-9035-2F7F4FEA6E61),
    dual,
    nonextensible,
    pointer_default(unique)
]
interface IEwProjectWireManagerX : IDispatch
{
    IEwProjectWireX findEwProjectWireByID (LONG lWireID,  EwErrorCode* errorCode);
 
    VARIANT getEwProjectWireArray (EwErrorCode* errorCode);
 
    IEwProjectWireX  newEwProjectWire (EwErrorCode* errorCode);
 
};
 
[
    object,
    uuid(80ca293e-1620-4b13-a6af-7cb1b076cbc3),
    dual,
    oleautomation,
    nonextensible,
    helpstring("IEwProjectWireStyleBase Interface"),
    pointer_default(unique)
]
interface IEwProjectWireStyleBase : IEwObjectX
{
    BSTR getName (EwErrorCode* errorCode);
 
    EwErrorCode setName (BSTR strName);
 
    BSTR getWireColorName (EwErrorCode* errorCode);
 
    EwErrorCode setWireColorName (BSTR strWireColorName);
 
    EwErrorCode setLineWidth (double dLineWidth);
 
    double getLineWidth (EwErrorCode* errorCode);
 
    EwErrorCode setColor (long lColor);
 
    long getColor (EwErrorCode* errorCode);
 
    EwErrorCode setEwProjectCableXByID (long lEwProjectCableID);
 
    long getEwProjectCableXByID (EwErrorCode* errorCode);
 
    IEwProjectCableX getEwProjectCableX (EwErrorCode* errorCode);
 
    EwErrorCode setTranslatedData (LONG nUserDataNumber,  BSTR strLanguage,  BSTR strValue);
 
    BSTR getTranslatedData (LONG nUserDataNumber,  BSTR strLanguage,  EwErrorCode* errorCode);
 
    BSTR getDescription (BSTR strLanguage,  EwErrorCode* errorCode);
 
    EwErrorCode setDescription (BSTR strLanguage,  BSTR strDescription);
 
};
 
[
    object,
    uuid(9e6cf696-9d07-4dba-87e9-79c9f3f08b27),
    dual,
    oleautomation,
    nonextensible,
    helpstring("IEwProjectWireStyleX Interface"),
    pointer_default(unique)
]
interface IEwProjectWireStyleX : IEwProjectWireStyleBase {
    BSTR getLinearMass (EwErrorCode* errorCode);
 
    EwErrorCode setLinearMass (BSTR strLinearMass);
 
    EwErrorCode setDispSchema (BSTR strDispSchema);
 
    BSTR getDispSchema (EwErrorCode* errorCode);
 
    BSTR getTension (EwErrorCode* errorCode);
 
    EwErrorCode setTension (BSTR strTension);
 
    BSTR getFrequence (EwErrorCode* errorCode);
 
    EwErrorCode setFrequence (BSTR strFrequence);
 
    BSTR getWireSectionGauge (EwErrorCode* errorCode);
 
    EwErrorCode setWireSectionGauge (BSTR strWireSectionGauge);
 
    BSTR getEquipTagFormula (EwErrorCode* errorCode);
 
    EwErrorCode setEquipTagFormula (BSTR strEquipTagFormula);
 
    BSTR getWireTagFormula (EwErrorCode* errorCode);
 
    EwErrorCode setWireTagFormula (BSTR strWireTagFormula);
 
    LONG getNumberID (EwErrorCode* errorCode);
 
    EwErrorCode setNumberID (LONG lNumberID);
 
    EwErrorCode setBendRadius (DOUBLE dBendRadius);
 
    DOUBLE getBendRadius (EwErrorCode* errorCode);
 
    BSTR getDispTerminal (EwErrorCode* errorCode);
 
    EwErrorCode setDispTerminal (BSTR strDispTerminal);
 
    BSTR getDispWiring (EwErrorCode* errorCode);
 
    EwErrorCode setDispWiring (BSTR strDispWiring);
 
    LONG getOrderNo (EwErrorCode* errorCode);
 
    EwErrorCode setOrderNo (LONG lOrderNo);
 
    EwErrorCode setEwPhaseType (EwPhaseType ePhaseType);
 
    EwPhaseType getEwPhaseType (EwErrorCode* errorCode);
 
    EwErrorCode setPropagate (VARIANT_BOOL bPropagate);
 
    VARIANT_BOOL getPropagate (EwErrorCode* errorCode);
 
    EwErrorCode setCableDiameter (double dDiameter);
 
    double getCableDiameter (EwErrorCode* errorCode);
 
    EwErrorCode setWireSizeStandard (EwWireSizeStandard eWireSizeStandard);
 
    EwWireSizeStandard getWireSizeStandard (EwErrorCode* errorCode);
 
}
 
[
    object,
    uuid(a5a637e3-6c9a-4d93-ac49-fb4d7280e414),
    dual,
    oleautomation,
    nonextensible,
    helpstring("IEwProjectWireStyleSynopticX Interface"),
    pointer_default(unique)
]
interface IEwProjectWireStyleSynopticX : IEwProjectWireStyleBase
{
}
 
[
    object,
    uuid(942eb12a-9425-4ee1-8bad-0f805b242005),
    dual,
    oleautomation,
    nonextensible,
    helpstring("IEwProjectWireStyleGroupX Interface"),
    pointer_default(unique)
]
interface IEwProjectWireStyleGroupX : IEwObjectX
{
    LONG getNumber (EwErrorCode* errorCode);
 
    EwErrorCode setNumber (LONG lNumberID);
 
    EwErrorCode setEwComputeOrderNumberType (EwComputeOrderNumberType eComputeOrderNumberType);
 
    EwComputeOrderNumberType getEwComputeOrderNumberType (EwErrorCode* errorCode);
 
    EwErrorCode setEwTagUnicityType (EwTagUnicityType eTagUnicityType);
 
    EwTagUnicityType  getEwTagUnicityType (EwErrorCode* errorCode);
 
    EwErrorCode setActive (VARIANT_BOOL bActive);
 
    VARIANT_BOOL getActive (EwErrorCode* errorCode);
 
    EwErrorCode setStartOrderNo (LONG lStartOrderNo);
 
    LONG getStartOrderNo (EwErrorCode* errorCode);
 
    EwErrorCode setTranslatedData (LONG nUserDataNumber,  BSTR strLanguage,  BSTR strValue);
 
    BSTR getTranslatedData (LONG nUserDataNumber,  BSTR strLanguage,  EwErrorCode* errorCode);
 
    BSTR getDescription (BSTR strLanguage,  EwErrorCode* errorCode);
 
    EwErrorCode setDescription (BSTR strLanguage,  BSTR strDescription);
 
};
 
[
    object,
    uuid(5f38b4b5-93ca-41fb-bd8f-eb2646d9c6d4),
    dual,
    nonextensible,
    pointer_default(unique)
]
interface IEwProjectWireStyleManagerX : IDispatch
{
    IEwProjectWireStyleX newEwProjectWireStyle (EwErrorCode* errorCode);
 
    VARIANT getEwProjectWireStyleArray (EwErrorCode* errorCode);
 
    IEwProjectWireStyleX findEwProjectWireStyleByID (LONG lWireStyleID, EwErrorCode* errorCode);
 
    VARIANT getEwProjectWireStyleGroupArray (EwErrorCode* errorCode);
 
    IEwProjectWireStyleGroupX newEwProjectWireStyleGroup (EwErrorCode* errorCode);
 
    IEwProjectWireStyleGroupX findEwProjectWireStyleGroupByID (LONG lWireStyleGroupID, EwErrorCode* errorCode);
 
    IEwProjectWireStyleSynopticX newEwProjectWireStyleSynoptic (EwErrorCode* errorCode);
 
    VARIANT getEwProjectWireStyleSynopticArray (EwErrorCode* errorCode);
 
    IEwProjectWireStyleSynopticX findEwProjectWireStyleSynopticByID (LONG lWireStyleID,  EwErrorCode* errorCode);
 
}
 
[
    object,
    uuid(1f2021e6-79b4-43e2-b486-2636b283e892),
    dual,
    nonextensible,
    pointer_default(unique)
]
interface IEwProjectLineX : IEwObjectX
{
    EwLineType getEwLineType (EwErrorCode* errorCode);
 
    LONG getWireStyleID (EwErrorCode* errorCode);
 
    EwErrorCode setWireStyleID (LONG lWireStyleID);
 
    long getFileID (EwErrorCode* errorCode);
 
    LONG getMeshID (EwErrorCode* errorCode);
 
    LONG getEquipotentialID (EwErrorCode* errorCode);
 
    IEwPointX getStartPointPosition (EwErrorCode* errorCode);
 
    EwErrorCode setStartPointPosition (IEwPointX* oStartPointX);
 
    IEwPointX getEndPointPosition (EwErrorCode* errorCode);
 
    EwErrorCode setEndPointPosition (IEwPointX* oEndPoint);
 
    BSTR getCableCoreText (EwErrorCode* errorCode);
 
    BSTR getWireMarkText (EwErrorCode* errorCode);
 
    LONG getCableLabelID (EwErrorCode* errorCode);
 
    long getEquipotentialLabelID (EwErrorCode* errorCode);
 
    long getWireLabelID (EwErrorCode* errorCode);
 
    EwNodalIndicatorType getStartNodalIndicatorType (EwErrorCode* errorCode);
 
    EwNodalIndicatorType getEndNodalIndicatorType (EwErrorCode* errorCode);
 
    double getStartPointXPosition (EwErrorCode* errorCode);
 
    EwErrorCode setStartPointXPosition (double dXCoordinate);
 
    double getStartPointYPosition (EwErrorCode* errorCode);
 
    EwErrorCode setStartPointYPosition (double dYCoordinate);
 
    double getEndPointXPosition (EwErrorCode* errorCode);
 
    EwErrorCode setEndPointXPosition (double dXCoordinate);
 
    double getEndPointYPosition (EwErrorCode* errorCode);
 
    EwErrorCode setEndPointYPosition (double dYCoordinate);
 
    EwLineAssociatedType getAssociatedType (EwErrorCode* errorCode);
 
    EwLineExtremityTypes getExtremityTypes (EwErrorCode* errorCode);
 
    EwErrorCode setWireStyleSynopticID (LONG lWireStyleSynopticID);
 
};
 
[
    object,
    uuid(73ee2402-2be1-47a4-8a5d-ced028c486e6),
    dual,
    nonextensible,
    pointer_default(unique)
]
interface IEwProjectLineManagerX : IDispatch
{
    IEwProjectLineX findEwProjectLineByID (LONG lLineID,  EwErrorCode* errorCode);
 
    VARIANT getEwProjectLineArray (EwErrorCode* errorCode);
 
    VARIANT getEwProjectLineArrayFromFileID (LONG lID,  EwErrorCode* errorCode);
 
};

Search 'SOLIDWORKS Electrical API: idl_converted/EwProjectWireObjects.idl Source File' in the SOLIDWORKS Knowledge Base.

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

Cancel

Print Topic

Select the scope of content to print:

This topic and all topics linked from this topic

Just this topic

This topic and only immediate topics under it

This selected topic and all subtopics

Cancel

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

Web Help Content Version: API Help (English only) 2025 SP2

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.