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
Collapse IEwObjectDispatchXIEwObjectDispatchX
Collapse IEwObjectBaseXIEwObjectBaseX
Expand IEwEnvironmentObjectXIEwEnvironmentObjectX
Collapse IEwObjectXIEwObjectX
IEwClassificationX
IEwProjectComponentCircuitX
IEwProjectConfigurationX
IEwProjectEntity3DX
IEwProjectInputOutputX
IEwProjectManufacturerPartX
IEwProjectMultilingualTextX
IEwProjectPrintConfigX
IEwProjectReportX
IEwProjectSymbolX
Expand IEwProjectTagObjectXIEwProjectTagObjectX
IEwProjectWireStyleGroupX
IEwProjectWireStyleX
IEwProjectWireX
IEwProjectComponentTerminalX
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
IEwProjectInputOutputX Interface Reference

Use this interface to manage input/output object inside a project. More...

Inheritance diagram for IEwProjectInputOutputX:
Inheritance graph

Public Member Functions

EwErrorCode setUserData (LONG nUserDataNumber, BSTR strValue)
 Set user data of the object. More...
 
BSTR getUserData (LONG nUserDataNumber, EwErrorCode *errorCode)
 Get user data of the object. More...
 
EwErrorCode setTranslatedData (LONG nUserDataNumber, BSTR strLanguage, BSTR strValue)
 Set the value of a translated text. More...
 
BSTR getTranslatedData (LONG nUserDataNumber, BSTR strLanguage, EwErrorCode *errorCode)
 Get the value of a translated text. More...
 
long getFunctionID (EwErrorCode *errorCode)
 Return the Function ID of the Input/Output object. More...
 
EwErrorCode setFunctionID (LONG lEwProjectFunctionID)
 Set the Function ID for the Input/Output object. More...
 
long getProjectComponentCircuitID (EwErrorCode *errorCode)
 Return the IEwProjectComponentCircuitX ID associated with the Input/Output object. More...
 
EwErrorCode setProjectComponentCircuitID (long lID)
 Sets the IEwProjectComponentCircuitX ID associated with the Input/Output object. More...
 
BSTR getKeyCode (EwErrorCode *errorCode)
 Return the Key for the cross reference. More...
 
EwErrorCode setKeyCode (BSTR strKey)
 Sets the Key for the cross reference. More...
 
BSTR getMnemonic (EwErrorCode *errorCode)
 Return the Mnemonic. More...
 
EwErrorCode setMnemonic (BSTR strMnemonic)
 Sets the Mnemonic. More...
 
BSTR getMacroName (EwErrorCode *errorCode)
 Return the name of the macro associated. More...
 
EwErrorCode setMacroName (BSTR strMacroName)
 Sets the name of the macro associated. More...
 
BSTR getChannelAddress (EwErrorCode *errorCode)
 Return the Channel Address. 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 input/output object inside a project.

Since
2021 SP1

Member Function Documentation

◆ getChannelAddress()

BSTR IEwProjectInputOutputX::getChannelAddress ( EwErrorCode *  errorCode)

Return the Channel Address.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT if current object has not been initialized
Returns
the Channel Address.

◆ getFunctionID()

long IEwProjectInputOutputX::getFunctionID ( EwErrorCode *  errorCode)

Return the Function ID of the Input/Output object.

-1 By default.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT if object is not initialized
Returns
the Function ID of the InputOutput object.

◆ getKeyCode()

BSTR IEwProjectInputOutputX::getKeyCode ( EwErrorCode *  errorCode)

Return the Key for the cross reference.

"PIA" by default.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_INVALID_OBJECT if current object has not been initialized
  • EW_UNDEFINED_ERROR if another error occurred
Returns
the Key for the cross reference.

◆ getMacroName()

BSTR IEwProjectInputOutputX::getMacroName ( EwErrorCode *  errorCode)

Return the name of the macro associated.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT if current object has not been initialized
Returns
Return the name of the macro associated

◆ getMnemonic()

BSTR IEwProjectInputOutputX::getMnemonic ( EwErrorCode *  errorCode)

Return the Mnemonic.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT if current object has not been initialized
Returns
the Mnemonic.

◆ getProjectComponentCircuitID()

long IEwProjectInputOutputX::getProjectComponentCircuitID ( EwErrorCode *  errorCode)

Return the IEwProjectComponentCircuitX ID associated with the Input/Output object.

-1 By default.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT if current object has not been initialized
Returns
the IEwProjectComponentCircuitX ID associated with the Input/Output object.

◆ getTranslatedData()

BSTR IEwProjectInputOutputX::getTranslatedData ( LONG  nUserDataNumber,
BSTR  strLanguage,
EwErrorCode *  errorCode 
)

Get the value of a translated text.

Parameters
[in]nUserDataNumberNumber of the text to get
[in]strLanguageLanguage code of the text to get
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR No error detected
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_OUT_OF_SCOPE number out of the scope supported by the method
  • EW_BAD_INPUTS if the language code is not supported
  • EW_INVALID_OBJECT if object is not initialized
Returns
Value of the text to get

◆ getUserData()

BSTR IEwProjectInputOutputX::getUserData ( LONG  nUserDataNumber,
EwErrorCode *  errorCode 
)

Get user data of the object.

Parameters
[in]nUserDataNumbernumber of the user data
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR No error detected
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_OUT_OF_SCOPE number out of the scope supported by the method
  • EW_INVALID_OBJECT if object is not initialized
Returns
value of the user data requested

◆ setFunctionID()

EwErrorCode IEwProjectInputOutputX::setFunctionID ( LONG  lEwProjectFunctionID)

Set the Function ID for the Input/Output object.

-1 By default.

Parameters
[in]lEwProjectFunctionIDFunction ID. Should be -1 to reinitialize this object.
Returns
errorCode EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_BAD_INPUT The Function with given ID doesn't exist in the active project
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT if object is not initialized

◆ setKeyCode()

EwErrorCode IEwProjectInputOutputX::setKeyCode ( BSTR  strKey)

Sets the Key for the cross reference.

Could be:

  • "PID" for PLC IO Input Digital
  • "PIA" for PLC IO Input Analog
  • "PIM" for PLC IO Input Misc
  • "POD" for PLC IO Output Digital
  • "POA" for PLC IO Output Analog
  • "POM" for PLC IO Output Misc
  • "P00" for PLC IO Misc
    Parameters
    [in]strKeythe new Key
    Returns
    EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_INVALID_OBJECT if current object has not been initialized
  • EW_BAD_INPUT The strKey is not valid.
  • EW_UNDEFINED_ERROR if another error occurred

◆ setMacroName()

EwErrorCode IEwProjectInputOutputX::setMacroName ( BSTR  strMacroName)

Sets the name of the macro associated.

Parameters
[in]strMacroNamethe new MacroName
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_INVALID_OBJECT if current object has not been initialized
  • EW_UNDEFINED_ERROR if another error occurred

◆ setMnemonic()

EwErrorCode IEwProjectInputOutputX::setMnemonic ( BSTR  strMnemonic)

Sets the Mnemonic.

Parameters
[in]strMnemonicthe new Mnemonic
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_INVALID_OBJECT if current object has not been initialized
  • EW_UNDEFINED_ERROR if another error occurred

◆ setProjectComponentCircuitID()

EwErrorCode IEwProjectInputOutputX::setProjectComponentCircuitID ( long  lID)

Sets the IEwProjectComponentCircuitX ID associated with the Input/Output object.

-1 By default.

Parameters
[in]lIDID of the Object. Should be -1 to reinitialize this object.
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_BAD_INPUT The lID is < -1 or the IEwProjectComponentCircuitX ID is not foud.
  • EW_INVALID_OBJECT if current object has not been initialized
  • EW_UNDEFINED_ERROR if another error occurred

◆ setTranslatedData()

EwErrorCode IEwProjectInputOutputX::setTranslatedData ( LONG  nUserDataNumber,
BSTR  strLanguage,
BSTR  strValue 
)

Set the value of a translated text.

Parameters
[in]nUserDataNumberNumber of the text to set
[in]strLanguageLanguage of the text
[in]strValueValue of the text
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR No error detected
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_OUT_OF_SCOPE number out of the scope supported by the method
  • EW_BAD_INPUTS if the language code is not supported
  • EW_INVALID_OBJECT if object is not initialized

◆ setUserData()

EwErrorCode IEwProjectInputOutputX::setUserData ( LONG  nUserDataNumber,
BSTR  strValue 
)

Set user data of the object.

Parameters
[in]nUserDataNumbernumber of the user data
[in]strValuevalue to set
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR No error detected
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_OUT_OF_SCOPE number out of the scope supported by the method
  • EW_INVALID_OBJECT if object is not initialized
Generated on Mon Aug 28 2023 13:39:21 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: IEwProjectInputOutputX 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.

0.20.21