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
IEwEnvironmentX
IEwLibraryManagerX
IEwLockStringX
IEwManagerDialogX
IEwManufacturerPartCircuitX
IEwManufacturerPartManagerX
IEwManufacturerPartTerminalX
IEwMenuItemX
IEwMenuManagerX
IEwMenuX
IEwNotificationDialogX
Expand IEwObjectDispatchXIEwObjectDispatchX
IEwPointX
IEwProjectAutomaticArrowsX
IEwProjectBookManagerX
IEwProjectCableManagerX
IEwProjectComponentManagerX
IEwProjectEntity3DManagerX
IEwProjectExcelAutomationX
IEwProjectExportDWGFilesX
IEwProjectExportPDFX
IEwProjectExportPDMX
IEwProjectExportReportX
IEwProjectFileConfigurationManagerX
IEwProjectFileConfigurationX
IEwProjectFileManagerX
IEwProjectFolderManagerX
IEwProjectFunctionManagerX
IEwProjectGenerateTSDrawingX
IEwProjectHarnessManagerX
IEwProjectInputOutputManagerX
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 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 2024.0.0
Electrical API
Public Member Functions | List of all members
IEwDialogMacroSelectorX Interface Reference

Use this interface to manage macro selector dialog. More...

Inheritance diagram for IEwDialogMacroSelectorX:
Inheritance graph

Public Member Functions

EwErrorCode setMacroFilterType (EwMacroFilterType eMacroFilterType)
 Initialize the EwMacroFilterType option, (kUnknownMacroFilterType by default). More...
 
EwErrorCode setMultiSelect (VARIANT_BOOL bMultiSelect)
 Initialize the MultiSelect option. More...
 
EwErrorCode setMacroId (long lMacroId)
 Initialize the MacroId option to specify the name of the macro that will be selected by default (-1 by default). More...
 
EwErrorCode setProjectId (long lProjectId)
 Initialize the ProjectId option to select only the macro of a project identified by the id. More...
 
EwErrorCode setMacroName (BSTR strMacroName)
 Initialize the macro name filter to select only the macro of a project identified by the name. More...
 
EwErrorCode setLibraryName (BSTR strLibraryName)
 Initialize the library name filter. More...
 
EwErrorCode setClassificationNodeId (long lClassificationNodeId)
 Initialize the classification node filter. More...
 
VARIANT_BOOL show (VARIANT *vMacroIdArray, EwErrorCode *errorCode)
 ShowDialog to select a macro. More...
 

Detailed Description

Use this interface to manage macro selector dialog.

Since
2018 SP0

Member Function Documentation

◆ setClassificationNodeId()

EwErrorCode IEwDialogMacroSelectorX::setClassificationNodeId ( long  lClassificationNodeId)

Initialize the classification node filter.

Parameters
[in]lClassificationNodeIdmacro node id filter
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_BAD_INPUTS if lClassificationNodeId is not a good value for the classification node
  • EW_UNDEFINED_ERROR if another error occurred

◆ setLibraryName()

EwErrorCode IEwDialogMacroSelectorX::setLibraryName ( BSTR  strLibraryName)

Initialize the library name filter.

By default it is initialized with the previously selected value.

Parameters
[in]strLibraryNamemacro name filter
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred

◆ setMacroFilterType()

EwErrorCode IEwDialogMacroSelectorX::setMacroFilterType ( EwMacroFilterType  eMacroFilterType)

Initialize the EwMacroFilterType option, (kUnknownMacroFilterType by default).

Parameters
[in]eMacroFilterTypeSet one value of EwMacroFilterType for MacroFilter option
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_BAD_INPUTS if nMacroFilterType is not a good value for the EwMacroFilterType enum
  • EW_UNDEFINED_ERROR if another error occurred

◆ setMacroId()

EwErrorCode IEwDialogMacroSelectorX::setMacroId ( long  lMacroId)

Initialize the MacroId option to specify the name of the macro that will be selected by default (-1 by default).

Parameters
[in]lMacroIdIdentifier of macro selected by default
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred

◆ setMacroName()

EwErrorCode IEwDialogMacroSelectorX::setMacroName ( BSTR  strMacroName)

Initialize the macro name filter to select only the macro of a project identified by the name.

Parameters
[in]strMacroNamemacro name filter
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred

◆ setMultiSelect()

EwErrorCode IEwDialogMacroSelectorX::setMultiSelect ( VARIANT_BOOL  bMultiSelect)

Initialize the MultiSelect option.

Parameters
[in]bMultiSelectSet VARIANT_TRUE to activate multi selection, VARIANT_FALSE for single selection
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred

◆ setProjectId()

EwErrorCode IEwDialogMacroSelectorX::setProjectId ( long  lProjectId)

Initialize the ProjectId option to select only the macro of a project identified by the id.

Parameters
[in]lProjectIdIdentifier of project (-1 by default)
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred

◆ show()

VARIANT_BOOL IEwDialogMacroSelectorX::show ( VARIANT *  vMacroIdArray,
EwErrorCode *  errorCode 
)

ShowDialog to select a macro.

Parameters
[out]vMacroIdArrayArray of the macro id's selected in the dialog box
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_MACROFILTERS_NOT_INITIALIZED if filters are not initialized
  • EW_BAD_INPUTS if variantMacroNameArray is not initialize
  • EW_UNDEFINED_ERROR if another error occurred
Returns
True for OK, false for Cancel
Generated on Mon Aug 28 2023 13:39:20 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: IEwDialogMacroSelectorX 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) 2024 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.

10.20.4