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 C# SamplesC# Samples
Expand List of SWE commandsList of SWE commands
Collapse ClassesClasses
Collapse Class ListClass List
Expand IEwAddInIEwAddIn
IEwAddinInternalX
Expand IEwAPIXIEwAPIX
Expand IEwApplicationSettingsXIEwApplicationSettingsX
Expand IEwApplicationXIEwApplicationX
Expand IEwArchiveEnvironmentXIEwArchiveEnvironmentX
Expand IEwCableCoreXIEwCableCoreX
Expand IEwCableReferenceManagerXIEwCableReferenceManagerX
Expand IEwCableReferenceXIEwCableReferenceX
Expand IEwCaptionBarControlXIEwCaptionBarControlX
Expand IEwCaptionBarXIEwCaptionBarX
Expand IEwClassificationManagerXIEwClassificationManagerX
Expand IEwClassificationXIEwClassificationX
Expand IEwClassXIEwClassX
IEwCommandContextX
Expand IEwCommandManagerXIEwCommandManagerX
Expand IEwCommandXIEwCommandX
Expand IEwDialogAlignPartsParametersSelectorXIEwDialogAlignPartsParametersSelectorX
Expand IEwDialogLocationSelectorXIEwDialogLocationSelectorX
Expand IEwDialogMacroSelectorXIEwDialogMacroSelectorX
Expand IEwDialogManufacturerPartOrderingXIEwDialogManufacturerPartOrderingX
Expand IEwDialogManufacturerPartSelectorXIEwDialogManufacturerPartSelectorX
Expand IEwDialogProgressXIEwDialogProgressX
Expand IEwDialogProjectManagerXIEwDialogProjectManagerX
Expand IEwDialogResumeXIEwDialogResumeX
Expand IEwDialogSummaryXIEwDialogSummaryX
Expand IEwDialogTaskXIEwDialogTaskX
Expand IEwDockingPaneManagerXIEwDockingPaneManagerX
Expand IEwDockingPaneXIEwDockingPaneX
Expand IEwDocumentManagerXIEwDocumentManagerX
Expand IEwDocumentXIEwDocumentX
Expand IEwEnvironmentObjectXIEwEnvironmentObjectX
Expand IEwEnvironmentXIEwEnvironmentX
IEwInteropFactoryX
Expand IEwLibraryManagerXIEwLibraryManagerX
Expand IEwLibraryXIEwLibraryX
Expand IEwLockStringXIEwLockStringX
Expand IEwManagerDialogXIEwManagerDialogX
Expand IEwManufacturerPartCircuitXIEwManufacturerPartCircuitX
Expand IEwManufacturerPartManagerXIEwManufacturerPartManagerX
Expand IEwManufacturerPartTerminalXIEwManufacturerPartTerminalX
Expand IEwManufacturerPartXIEwManufacturerPartX
Expand IEwMenuItemXIEwMenuItemX
Expand IEwMenuManagerXIEwMenuManagerX
Expand IEwMenuXIEwMenuX
Expand IEwNotificationDialogXIEwNotificationDialogX
Expand IEwObjectBaseXIEwObjectBaseX
IEwObjectDispatchX
Expand IEwObjectXIEwObjectX
Expand IEwPointXIEwPointX
Expand IEwProjectAutomaticArrowsXIEwProjectAutomaticArrowsX
Expand IEwProjectBookManagerXIEwProjectBookManagerX
IEwProjectBookX
Expand IEwProjectCableManagerXIEwProjectCableManagerX
Expand IEwProjectCableXIEwProjectCableX
Expand IEwProjectComponentCircuitXIEwProjectComponentCircuitX
Expand IEwProjectComponentManagerXIEwProjectComponentManagerX
Expand IEwProjectComponentTerminalXIEwProjectComponentTerminalX
Expand IEwProjectComponentXIEwProjectComponentX
Expand IEwProjectConfigurationXIEwProjectConfigurationX
Expand IEwProjectEntity3DManagerXIEwProjectEntity3DManagerX
Expand IEwProjectEntity3DXIEwProjectEntity3DX
Expand IEwProjectExcelAutomationXIEwProjectExcelAutomationX
Expand IEwProjectExportDWGFilesXIEwProjectExportDWGFilesX
Expand IEwProjectExportPDFXIEwProjectExportPDFX
Expand IEwProjectExportPDMXIEwProjectExportPDMX
Expand IEwProjectExportReportXIEwProjectExportReportX
Expand IEwProjectFileConfigurationManagerXIEwProjectFileConfigurationManagerX
Expand IEwProjectFileConfigurationXIEwProjectFileConfigurationX
Expand IEwProjectFileManagerXIEwProjectFileManagerX
Expand IEwProjectFileXIEwProjectFileX
Expand IEwProjectFolderManagerXIEwProjectFolderManagerX
Expand IEwProjectFolderXIEwProjectFolderX
Expand IEwProjectFunctionManagerXIEwProjectFunctionManagerX
Expand IEwProjectFunctionXIEwProjectFunctionX
Expand IEwProjectGenerateTSDrawingXIEwProjectGenerateTSDrawingX
Expand IEwProjectHarnessManagerXIEwProjectHarnessManagerX
Expand IEwProjectHarnessXIEwProjectHarnessX
Expand IEwProjectInputOutputManagerXIEwProjectInputOutputManagerX
Expand IEwProjectInputOutputXIEwProjectInputOutputX
Expand IEwProjectLocationManagerXIEwProjectLocationManagerX
Expand IEwProjectLocationXIEwProjectLocationX
Expand IEwProjectManagerXIEwProjectManagerX
IEwProjectManufacturerPartCircuitX
Expand IEwProjectManufacturerPartManagerXIEwProjectManufacturerPartManagerX
IEwProjectManufacturerPartTerminalX
Expand IEwProjectManufacturerPartXIEwProjectManufacturerPartX
Expand IEwProjectMultilingualTextFontXIEwProjectMultilingualTextFontX
Expand IEwProjectMultilingualTextManagerXIEwProjectMultilingualTextManagerX
Expand IEwProjectMultilingualTextXIEwProjectMultilingualTextX
Expand IEwProjectNumberDocumentsXIEwProjectNumberDocumentsX
Expand IEwProjectNumberMarksXIEwProjectNumberMarksX
Collapse IEwProjectNumberWiresXIEwProjectNumberWiresX
Expand IEwProjectOptimizeWireOrderXIEwProjectOptimizeWireOrderX
Expand IEwProjectPrintConfigManagerXIEwProjectPrintConfigManagerX
Expand IEwProjectPrintConfigXIEwProjectPrintConfigX
Expand IEwProjectReportManagerXIEwProjectReportManagerX
Expand IEwProjectReportXIEwProjectReportX
Expand IEwProjectSnapshotManagerXIEwProjectSnapshotManagerX
Expand IEwProjectSnapshotXIEwProjectSnapshotX
Expand IEwProjectSymbolManagerXIEwProjectSymbolManagerX
Expand IEwProjectSymbolXIEwProjectSymbolX
Expand IEwProjectTagObjectXIEwProjectTagObjectX
Expand IEwProjectUpdateReplaceDataXIEwProjectUpdateReplaceDataX
Expand IEwProjectWireManagerXIEwProjectWireManagerX
Expand IEwProjectWireXIEwProjectWireX
Expand IEwProjectXIEwProjectX
Expand IEwResumeRowXIEwResumeRowX
Expand IEwRibbonComboBoxControlXIEwRibbonComboBoxControlX
Expand IEwRibbonControlXIEwRibbonControlX
Expand IEwRibbonGroupXIEwRibbonGroupX
Expand IEwRibbonQuickAccessControlXIEwRibbonQuickAccessControlX
Expand IEwRibbonTabXIEwRibbonTabX
Expand IEwRibbonXIEwRibbonX
Expand IEwRightsManagerXIEwRightsManagerX
Expand IEwSaveDWGImageXIEwSaveDWGImageX
Expand IEwSelectorDialogXIEwSelectorDialogX
Expand IEwSymbolCircuitXIEwSymbolCircuitX
Expand IEwSymbolFiltersXIEwSymbolFiltersX
Expand IEwSymbolManagerXIEwSymbolManagerX
Expand IEwSymbolPointXIEwSymbolPointX
Expand IEwSymbolXIEwSymbolX
Expand IEwTerminalTypeManagerXIEwTerminalTypeManagerX
Expand IEwTerminalTypeXIEwTerminalTypeX
Expand IEwTitleBlockManagerXIEwTitleBlockManagerX
Expand IEwTitleBlockXIEwTitleBlockX
Expand IEwWireTerminationTypeManagerXIEwWireTerminationTypeManagerX
Expand IEwWireTerminationTypeXIEwWireTerminationTypeX
Expand IEwXLSBookXIEwXLSBookX
Expand IEwXLSSheetXIEwXLSSheetX
Expand IInteropFactoryXIInteropFactoryX
Class Index
Expand Class HierarchyClass Hierarchy
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 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 2023.0.0
Electrical API
Public Member Functions | List of all members
IEwProjectNumberWiresX Interface Reference

Use this interface to manage the numbering or renumbering of wires. More...

Inheritance diagram for IEwProjectNumberWiresX:
Inheritance graph
[legend]

Public Member Functions

VARIANT_BOOL getActionOnManualNumber (EwErrorCode *errorCode)
 Return true if the action should be done on the Manual number. More...
 
EwErrorCode setActionOnManualNumber (VARIANT_BOOL bActionOnManualNumber)
 Set this value to true if the action should be done on the Manual number. More...
 
VARIANT_BOOL getResetPosition (EwErrorCode *errorCode)
 Return true if reset position of wire marks is activated. More...
 
EwErrorCode setResetPosition (VARIANT_BOOL bResetPosition)
 Set this value to true to reset the position of wire marks. More...
 
EwSelectionType getSelectionType (EwErrorCode *errorCode)
 Return the EwSelectionType enum to specify the type of selection to use. More...
 
EwErrorCode setSelectionType (EwSelectionType eSelectionType)
 Set the EwSelectionType enum to specify the type of selection to use. More...
 
VARIANT getSelection (EwErrorCode *errorCode)
 Return the array of ID used to specify the selection of objects to include in renumbering process. More...
 
EwErrorCode setSelection (VARIANT vIDArray)
 Set the array of ID according to selection type. More...
 
EwErrorCode process (EwNumberWireAction eEwNumberAction)
 Process function to number or renumber wires in the current project. More...
 

Detailed Description

Use this interface to manage the numbering or renumbering of wires.

Since
2019 SP0

Member Function Documentation

◆ getActionOnManualNumber()

VARIANT_BOOL IEwProjectNumberWiresX::getActionOnManualNumber ( EwErrorCode *  errorCode)

Return true if the action should be done on the Manual number.

False is the Default value.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred
Returns
true if the action should be done on the Manual number.

◆ getResetPosition()

VARIANT_BOOL IEwProjectNumberWiresX::getResetPosition ( EwErrorCode *  errorCode)

Return true if reset position of wire marks is activated.

False is the Default value.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred
Returns
true if reset position of wire marks is activated.

◆ getSelection()

VARIANT IEwProjectNumberWiresX::getSelection ( EwErrorCode *  errorCode)

Return the array of ID used to specify the selection of objects to include in renumbering process.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred

◆ getSelectionType()

EwSelectionType IEwProjectNumberWiresX::getSelectionType ( EwErrorCode *  errorCode)

Return the EwSelectionType enum to specify the type of selection to use.

kSelectionAll is the default value.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred
Returns
the EwSelectionType enum to specify the type of selection to use.

◆ process()

EwErrorCode IEwProjectNumberWiresX::process ( EwNumberWireAction  eEwNumberAction)

Process function to number or renumber wires in the current project.

Parameters
[in]eEwNumberActionthe enum type of numbering action in the current project.
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_BAD_INPUTS if eEwNumberAction is not allow for wires
  • EW_UNDEFINED_ERROR if another error occurred

◆ setActionOnManualNumber()

EwErrorCode IEwProjectNumberWiresX::setActionOnManualNumber ( VARIANT_BOOL  bActionOnManualNumber)

Set this value to true if the action should be done on the Manual number.

False is the Default value. Work only for kRemoveNumberWiresAction and kReNumberWiresAction enum value.

Parameters
[in]bActionOnManualNumberSet this value to true if the action should be done on the Manual number.
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred

◆ setResetPosition()

EwErrorCode IEwProjectNumberWiresX::setResetPosition ( VARIANT_BOOL  bResetPosition)

Set this value to true to reset the position of wire marks.

This option is only usable with action kRemoveNumberWiresAction. False is the Default value.

Parameters
[in]bResetPositionState if the reset position of wire mark. Set it to true to reset the position.
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred

◆ setSelection()

EwErrorCode IEwProjectNumberWiresX::setSelection ( VARIANT  vIDArray)

Set the array of ID according to selection type.

Array of ID must be consistent with SelectionType:

  • kSelectionFolder, the array must contains ID of EwProjectFolder
  • kSelectionBook, the array must contains ID of EwProjectBook
  • kSelectionScheme, the array must contains ID of EwProjectFile
    Parameters
    [in]vIDArrayan array of ID.
    Returns
    EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred

◆ setSelectionType()

EwErrorCode IEwProjectNumberWiresX::setSelectionType ( EwSelectionType  eSelectionType)

Set the EwSelectionType enum to specify the type of selection to use.

Parameters
[in]eSelectionTypeSet this value to select the type of selection that you want.
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_BAD_INPUTS if value is kSelectionUndefined or not define in the enum.
  • EW_UNDEFINED_ERROR if another error occurred
Generated on Thu Aug 25 2022 16:02:39 for SOLIDWORKS Electrical API 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: IEwProjectNumberWiresX 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) 2023 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