Welcome
Expand Getting StartedGetting Started
Expand SOLIDWORKS API HelpSOLIDWORKS API Help
Collapse SOLIDWORKS Electrical API HelpSOLIDWORKS Electrical API Help
Expand Getting StartedGetting Started
Expand Add a Custom CommandAdd a Custom Command
Expand Add an Add-inAdd an Add-in
Expand Release NotesRelease Notes
Expand SampleSample
Collapse ClassesClasses
Expand Class ListClass List
Class Index
Collapse Class HierarchyClass Hierarchy
Collapse IDispatchIDispatch
IEwAPIX
IEwAddIn
IEwAddinInternalX
IEwApplicationSettingsX
IEwApplicationX
IEwArchiveEnvironmentX
IEwCableCoreX
IEwCableReferenceManagerX
IEwCaptionBarControlX
IEwCaptionBarX
IEwClassificationManagerX
IEwCommandContextX
IEwCommandManagerX
IEwCommandX
IEwDialogAlignPartsParametersSelectorX
IEwDialogLocationSelectorX
IEwDialogMacroSelectorX
IEwDialogManufacturerPartOrderingX
IEwDialogManufacturerPartSelectorX
IEwDialogProgressX
IEwDialogProjectManagerX
IEwDialogResumeX
IEwDialogSummaryX
IEwDialogTaskX
IEwDockingPaneManagerX
IEwDockingPaneX
IEwDocumentManagerX
IEwDocumentX
IEwEXCELImportLibraryX
IEwEnvironmentX
IEwLibraryManagerX
IEwLockStringX
IEwManagerDialogX
IEwManufacturerPartCircuitX
IEwManufacturerPartManagerX
IEwManufacturerPartTerminalX
IEwMenuItemX
IEwMenuManagerX
IEwMenuX
IEwNotificationDialogX
Collapse IEwObjectDispatchXIEwObjectDispatchX
IEwPointX
IEwProjectAutomaticArrowsX
IEwProjectBookManagerX
IEwProjectCableManagerX
IEwProjectComponentManagerX
IEwProjectEntity3DManagerX
IEwProjectExcelAutomationX
IEwProjectExportDWGFilesX
IEwProjectExportPDFX
IEwProjectExportPDMX
IEwProjectExportReportX
IEwProjectFileConfigurationManagerX
IEwProjectFileConfigurationX
IEwProjectFileManagerX
IEwProjectFolderManagerX
IEwProjectFunctionManagerX
IEwProjectGenerateTSDrawingX
IEwProjectHarnessManagerX
IEwProjectInputOutputManagerX
IEwProjectLineManagerX
IEwProjectLocationManagerX
IEwProjectManagerX
IEwProjectManufacturerPartCircuitX
IEwProjectManufacturerPartManagerX
IEwProjectManufacturerPartTerminalX
IEwProjectMultilingualTextFontX
IEwProjectMultilingualTextManagerX
IEwProjectNumberDocumentsX
IEwProjectNumberMarksX
IEwProjectNumberWiresX
IEwProjectOptimizeWireOrderX
IEwProjectPrintConfigManagerX
IEwProjectReportManagerX
IEwProjectSnapshotManagerX
IEwProjectSnapshotX
IEwProjectSymbolManagerX
IEwProjectUpdateReplaceDataX
IEwProjectWireManagerX
IEwProjectWireStyleManagerX
IEwProjectX
IEwResumeRowX
IEwRibbonComboBoxControlX
IEwRibbonControlX
IEwRibbonGroupX
IEwRibbonQuickAccessControlX
IEwRibbonTabX
IEwRibbonX
IEwRightsManagerX
IEwSaveDWGImageX
IEwSelectorDialogX
IEwSymbolCircuitX
IEwSymbolFiltersX
IEwSymbolManagerX
IEwSymbolPointX
IEwTerminalTypeManagerX
IEwTitleBlockManagerX
IEwWireTerminationTypeManagerX
IEwXLSBookX
IEwXLSSheetX
Expand IInteropFactoryXIInteropFactoryX
Expand Class MembersClass Members
Expand SOLIDWORKS PDM Professional API HelpSOLIDWORKS PDM Professional API Help
Expand PDM Pro API Web ServicePDM Pro API Web Service
Expand FeatureWorks API HelpFeatureWorks API Help
Expand SOLIDWORKS Costing API HelpSOLIDWORKS Costing API Help
Expand SOLIDWORKS Document Manager API HelpSOLIDWORKS Document Manager API Help
Expand SOLIDWORKS Inspection API HelpSOLIDWORKS Inspection API Help
Expand SOLIDWORKS Routing API HelpSOLIDWORKS Routing API Help
Expand SOLIDWORKS Simulation API HelpSOLIDWORKS Simulation API Help
Expand SOLIDWORKS Sustainability API HelpSOLIDWORKS Sustainability API Help
Expand SOLIDWORKS Toolbox API HelpSOLIDWORKS Toolbox API Help
Expand SOLIDWORKS Utilities API HelpSOLIDWORKS Utilities API Help
Expand SOLIDWORKS Visualize API HelpSOLIDWORKS Visualize API Help
Expand eDrawings API HelpeDrawings API Help
Expand DraftSight API HelpDraftSight API Help
Expand Lisp Programming BasicsLisp Programming Basics
Expand Lisp Functions OverviewLisp Functions Overview
Expand Lisp Functions ReferenceLisp Functions Reference
Expand Visual Lisp Compatible FunctionsVisual Lisp Compatible Functions
Hide Table of Contents
SOLIDWORKS Electrical API 2025.0.0
Electrical API
Public Member Functions | List of all members
IEwProjectLineX Interface Reference

Use this interface to manage Line inside a project To create a new Line, use the object EwProjectFileX Since 2024 SP1. More...

Inheritance diagram for IEwProjectLineX:

Public Member Functions

EwLineType getEwLineType (EwErrorCode *errorCode)
 Get the line type of the current object. More...
 
LONG getWireStyleID (EwErrorCode *errorCode)
 Get the ID of the line wire style of the current object. More...
 
EwErrorCode setWireStyleID (LONG lWireStyleID)
 Set the ID of the line wire style of the current object. More...
 
long getFileID (EwErrorCode *errorCode)
 Get the File ID associated to the current object. More...
 
LONG getMeshID (EwErrorCode *errorCode)
 Get the Mesh ID associated to the current object. More...
 
LONG getEquipotentialID (EwErrorCode *errorCode)
 Get the Equipotential ID of the current object. More...
 
IEwPointX getStartPointPosition (EwErrorCode *errorCode)
 Get the starting point of the line. More...
 
EwErrorCode setStartPointPosition (IEwPointX *oStartPointX)
 Set the starting point of the line. More...
 
IEwPointX getEndPointPosition (EwErrorCode *errorCode)
 Get the ending point of the line. More...
 
EwErrorCode setEndPointPosition (IEwPointX *oEndPoint)
 Set the ending point of the line. More...
 
BSTR getCableCoreText (EwErrorCode *errorCode)
 Get the cable wire text. More...
 
BSTR getWireMarkText (EwErrorCode *errorCode)
 Get a string of the wire mark text associated to the current object. More...
 
LONG getCableLabelID (EwErrorCode *errorCode)
 Get the cable label ID. More...
 
long getEquipotentialLabelID (EwErrorCode *errorCode)
 Get the eqiupotential label ID. More...
 
long getWireLabelID (EwErrorCode *errorCode)
 Get the ID of the wire label. More...
 
EwNodalIndicatorType getStartNodalIndicatorType (EwErrorCode *errorCode)
 Get the starting Nodal Indicator Type of the current object. More...
 
EwNodalIndicatorType getEndNodalIndicatorType (EwErrorCode *errorCode)
 Get the ending Nodal Indicator Type of the current object. More...
 
double getStartPointXPosition (EwErrorCode *errorCode)
 Get the starting point X axis position of the line. More...
 
EwErrorCode setStartPointXPosition (double dXCoordinate)
 Set the starting point X axis position of the line. More...
 
double getStartPointYPosition (EwErrorCode *errorCode)
 Get the starting point Y axis position of the line. More...
 
EwErrorCode setStartPointYPosition (double dYCoordinate)
 Set the starting point Y axis position of the line. More...
 
double getEndPointXPosition (EwErrorCode *errorCode)
 Get the ending point X axis position of the line. More...
 
EwErrorCode setEndPointXPosition (double dXCoordinate)
 Set the ending point X axis position of the line. More...
 
double getEndPointYPosition (EwErrorCode *errorCode)
 Get the ending point Y axis position of the line. More...
 
EwErrorCode setEndPointYPosition (double dYCoordinate)
 Set the ending point Y axis position of the line. More...
 
EwLineAssociatedType getAssociatedType (EwErrorCode *errorCode)
 Get the associated wire type of this line. More...
 
EwLineExtremityTypes getExtremityTypes (EwErrorCode *errorCode)
 Get the extremity types of this line. More...
 
EwErrorCode setWireStyleSynopticID (LONG lWireStyleSynopticID)
 Set the ID of the line wire style of the current object. More...
 
- Public Member Functions inherited from IEwObjectX
LONG getID ()
 
- Public Member Functions inherited from IEwObjectBaseX
EwErrorCode insert ()
 Insert the object inside the current project. More...
 
EwErrorCode remove ()
 Remove the object from the current project. More...
 
EwErrorCode update ()
 Update the object inside the current project. More...
 

Detailed Description

Use this interface to manage Line inside a project To create a new Line, use the object EwProjectFileX Since 2024 SP1.

Member Function Documentation

◆ getAssociatedType()

EwLineAssociatedType IEwProjectLineX::getAssociatedType ( EwErrorCode *  errorCode)

Get the associated wire type of this line.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT if the current object is invalid
  • EW_NO_ERROR if no error detected
Returns
EwLineAssociatedType enum type, can be:
  • kAssociatedTypeUnknown
  • kAssociatedTypeNothing
  • kAssociatedTypeCableCore
  • kAssociatedTypeBridge

◆ getCableCoreText()

BSTR IEwProjectLineX::getCableCoreText ( EwErrorCode *  errorCode)

Get the cable wire text.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT if the current object is invalid
  • EW_NO_ERROR if no error detected
Returns
the cable wire text

◆ getCableLabelID()

LONG IEwProjectLineX::getCableLabelID ( EwErrorCode *  errorCode)

Get the cable label ID.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT if the current object is invalid
  • EW_NO_ERROR if no error detected
Returns
ID of the cable label

◆ getEndNodalIndicatorType()

EwNodalIndicatorType IEwProjectLineX::getEndNodalIndicatorType ( EwErrorCode *  errorCode)

Get the ending Nodal Indicator Type of the current object.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT if the current object is invalid or if the line type is different from kLineSchematic
  • EW_NO_ERROR if no error detected
Returns
the ending Nodal Indicator Type of the current object, can be:
  • kEwNodalIndicatorTypeUnknown
  • kNo No nodal indicator
  • kHidden Nodal indicator is hidden
  • kNodalLeft Nodal indicator is at left
  • kNodalRight Nodal indicator is at right

◆ getEndPointPosition()

IEwPointX IEwProjectLineX::getEndPointPosition ( EwErrorCode *  errorCode)

Get the ending point of the line.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT if the current object is invalid
  • EW_NO_ERROR if no error detected
Returns
EwPointX corresponding the the ending point of the line in 2D

◆ getEndPointXPosition()

double IEwProjectLineX::getEndPointXPosition ( EwErrorCode *  errorCode)

Get the ending point X axis position of the line.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT if the current object is invalid
  • EW_NO_ERROR if no error detected
Returns
X axis position of the ending point of the line.

◆ getEndPointYPosition()

double IEwProjectLineX::getEndPointYPosition ( EwErrorCode *  errorCode)

Get the ending point Y axis position of the line.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT if the current object is invalid
  • EW_NO_ERROR if no error detected
Returns
Y axis position of the ending point of the line.

◆ getEquipotentialID()

LONG IEwProjectLineX::getEquipotentialID ( EwErrorCode *  errorCode)

Get the Equipotential ID of the current object.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT if the current object is invalid
  • EW_NO_ERROR if no error detected
Returns
the equipotential ID of the current object

◆ getEquipotentialLabelID()

long IEwProjectLineX::getEquipotentialLabelID ( EwErrorCode *  errorCode)

Get the eqiupotential label ID.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT if the current object is invalid
  • EW_NO_ERROR if no error detected
Returns
ID of the equipotential label

◆ getEwLineType()

EwLineType IEwProjectLineX::getEwLineType ( EwErrorCode *  errorCode)

Get the line type of the current object.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT if the current object is invalid
  • EW_NO_ERROR if no error detected
Returns
EwLineType enum type, can be:
  • kLineUnknown
  • kLineSchematic Line type : Scheme
  • kLineSynoptic Line type : Line Diagram
  • kLinePID Line type : P&ID scheme

◆ getExtremityTypes()

EwLineExtremityTypes IEwProjectLineX::getExtremityTypes ( EwErrorCode *  errorCode)

Get the extremity types of this line.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT if the current object is invalid or if the line extremity type is unknown
  • EW_NO_ERROR if no error detected
Returns
EwLineExtremityTypes enum, can be:
  • kExtremityTypesUnknown
  • kExtremityTypesNo No extremity type
  • kExtremityTypesMesh Mesh type extremity
  • kExtremityTypesEquip Equipotential type extremity
  • kExtremityTypesMeshAndEquip Mesh and equipotential types extremity

◆ getFileID()

long IEwProjectLineX::getFileID ( EwErrorCode *  errorCode)

Get the File ID associated to the current object.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT if the current object is invalid
  • EW_NO_ERROR if no error detected
Returns
the ID of the file associated to the current object

◆ getMeshID()

LONG IEwProjectLineX::getMeshID ( EwErrorCode *  errorCode)

Get the Mesh ID associated to the current object.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT if the current object is invalid
  • EW_NO_ERROR if no error detected
Returns
the ID of the Mesh associated to the current object

◆ getStartNodalIndicatorType()

EwNodalIndicatorType IEwProjectLineX::getStartNodalIndicatorType ( EwErrorCode *  errorCode)

Get the starting Nodal Indicator Type of the current object.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT if the current object is invalid or if the line type is different from kLineSchematic
  • EW_NO_ERROR if no error detected
Returns
the starting Nodal Indicator Type of the current object, can be:
  • kEwNodalIndicatorTypeUnknown
  • kNo No nodal indicator
  • kHidden Nodal indicator is hidden
  • kNodalLeft Nodal indicator is at left
  • kNodalRight Nodal indicator is at right

◆ getStartPointPosition()

IEwPointX IEwProjectLineX::getStartPointPosition ( EwErrorCode *  errorCode)

Get the starting point of the line.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT if the current object is invalid
  • EW_NO_ERROR if no error detected
Returns
EwPointX corresponding to the starting point of the line in 2D

◆ getStartPointXPosition()

double IEwProjectLineX::getStartPointXPosition ( EwErrorCode *  errorCode)

Get the starting point X axis position of the line.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT if the current object is invalid
  • EW_NO_ERROR if no error detected
Returns
X axis position of the starting point of the line.

◆ getStartPointYPosition()

double IEwProjectLineX::getStartPointYPosition ( EwErrorCode *  errorCode)

Get the starting point Y axis position of the line.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT if the current object is invalid
  • EW_NO_ERROR if no error detected
Returns
Y axis position of the starting point of the line.

◆ getWireLabelID()

long IEwProjectLineX::getWireLabelID ( EwErrorCode *  errorCode)

Get the ID of the wire label.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT if the current object is invalid
  • EW_NO_ERROR if no error detected
Returns
the ID of the wire label

◆ getWireMarkText()

BSTR IEwProjectLineX::getWireMarkText ( EwErrorCode *  errorCode)

Get a string of the wire mark text associated to the current object.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT if the current object is invalid
  • EW_NO_ERROR if no error detected
Returns
text contained in the wire mark associate to the current object

◆ getWireStyleID()

LONG IEwProjectLineX::getWireStyleID ( EwErrorCode *  errorCode)

Get the ID of the line wire style of the current object.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT if the current object is invalid
  • EW_NO_ERROR if no error detected
Returns
the line style type ID of the current object

◆ setEndPointPosition()

EwErrorCode IEwProjectLineX::setEndPointPosition ( IEwPointX *  oEndPoint)

Set the ending point of the line.

Parameters
[in]oEndPointEwPointX corresponding to the ending point
Returns
EwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT if the current object is invalid
  • EW_NO_ERROR if no error detected

◆ setEndPointXPosition()

EwErrorCode IEwProjectLineX::setEndPointXPosition ( double  dXCoordinate)

Set the ending point X axis position of the line.

Parameters
[in]dXCoordinatedouble corresponding to the X axis position of the ending point
Returns
EwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT if the current object is invalid
  • EW_NO_ERROR if no error detected

◆ setEndPointYPosition()

EwErrorCode IEwProjectLineX::setEndPointYPosition ( double  dYCoordinate)

Set the ending point Y axis position of the line.

Parameters
[in]dYCoordinatedouble corresponding to the Y axis position of the ending point
Returns
EwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT if the current object is invalid
  • EW_NO_ERROR if no error detected

◆ setStartPointPosition()

EwErrorCode IEwProjectLineX::setStartPointPosition ( IEwPointX *  oStartPointX)

Set the starting point of the line.

Parameters
[in]oStartPointXEwPointX corresponding to the starting point
Returns
EwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT if the current object is invalid
  • EW_NO_ERROR if no error detected

◆ setStartPointXPosition()

EwErrorCode IEwProjectLineX::setStartPointXPosition ( double  dXCoordinate)

Set the starting point X axis position of the line.

Parameters
[in]dXCoordinatedouble corresponding to the X axis position of the starting point
Returns
EwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT if the current object is invalid
  • EW_NO_ERROR if no error detected

◆ setStartPointYPosition()

EwErrorCode IEwProjectLineX::setStartPointYPosition ( double  dYCoordinate)

Set the starting point Y axis position of the line.

Parameters
[in]dYCoordinatedouble corresponding to the Y axis position of the starting point
Returns
EwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT if the current object is invalid
  • EW_NO_ERROR if no error detected

◆ setWireStyleID()

EwErrorCode IEwProjectLineX::setWireStyleID ( LONG  lWireStyleID)

Set the ID of the line wire style of the current object.

Parameters
[in]lWireStyleIDID of the line type
Returns
EwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT if the current object is invalid or the LineType is different from kLineSchematic
  • EW_BAD_INPUTS if the lWireStyleID does not match any wire style ID
  • EW_NO_ERROR if no error detected

◆ setWireStyleSynopticID()

EwErrorCode IEwProjectLineX::setWireStyleSynopticID ( LONG  lWireStyleSynopticID)

Set the ID of the line wire style of the current object.

Since
2025 SP01
Parameters
[in]lWireStyleSynopticIDID of the line type
Returns
EwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT if the current object is invalid or the LineType is different from kLineSynoptic
  • EW_BAD_INPUTS if the lWireStyleSynopticID does not match any synoptic wire style ID
  • EW_NO_ERROR if no error detected
Generated by doxygen 1.9.4


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: IEwProjectLineX Interface Reference
*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) 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.

0.20.21