Welcome
Expand Getting StartedGetting Started
Expand SOLIDWORKS API HelpSOLIDWORKS API Help
Collapse SOLIDWORKS Electrical API HelpSOLIDWORKS Electrical API Help
Expand Getting StartedGetting Started
Expand Release NotesRelease Notes
Collapse ClassesClasses
Expand Class ListClass List
Class Index
Collapse Class HierarchyClass Hierarchy
_DIEwProjectXEvents
Collapse IDispatchIDispatch
IEwAddIn
IEwAPIX
IEwApplicationReactorX
IEwApplicationSettingsX
IEwApplicationX
IEwArchiveEnvironmentX
IEwCableCoreX
IEwCableReferenceManagerX
IEwCableReferenceX
IEwCaptionBarControlX
IEwCaptionBarX
IEwCommandContextX
IEwCommandManagerX
IEwCommandX
IEwDialogAlignPartsParametersSelectorX
IEwDialogLocationSelectorX
IEwDialogMacroSelectorX
IEwDialogManufacturerPartOrderingX
IEwDialogManufacturerPartSelectorX
IEwDialogProgressX
IEwDialogProjectManagerX
IEwDialogResumeX
IEwDialogSummaryX
IEwDialogTaskX
IEwDockingPaneManagerX
IEwDockingPaneX
IEwEnvironmentX
IEwInteropFactoryX
IEwLibraryManagerX
IEwLibraryX
IEwLockStringX
IEwManagerDialogX
IEwManufacturerPartCircuitX
IEwManufacturerPartManagerX
IEwManufacturerPartTerminalX
Expand IEwObjectBaseXIEwObjectBaseX
IEwPointX
IEwProjectAutomaticArrowsX
IEwProjectBookManagerX
IEwProjectCableManagerX
IEwProjectComponentManagerX
IEwProjectComponentTerminalX
IEwProjectEntity3DManagerX
IEwProjectExcelAutomationX
IEwProjectExportDWGFilesX
IEwProjectExportPDFX
IEwProjectExportPDMX
IEwProjectExportReportX
IEwProjectFileManagerX
IEwProjectFolderManagerX
IEwProjectFunctionManagerX
IEwProjectGenerateTSDrawingX
IEwProjectHarnessManagerX
IEwProjectInputOutputManagerX
IEwProjectLocationManagerX
IEwProjectManagerX
IEwProjectManufacturerPartCircuitX
IEwProjectManufacturerPartManagerX
IEwProjectManufacturerPartTerminalX
IEwProjectManufacturerPartX
IEwProjectNumberDocumentsX
IEwProjectNumberMarksX
IEwProjectNumberWiresX
IEwProjectOptimizeWireOrderX
IEwProjectPrintConfigManagerX
IEwProjectReportManagerX
IEwProjectSnapshotManagerX
IEwProjectSnapshotX
IEwProjectSymbolManagerX
IEwProjectUpdateReplaceDataX
IEwProjectWireManagerX
IEwProjectX
IEwResumeRowX
IEwRibbonComboBoxControlX
IEwRibbonControlX
IEwRibbonGroupX
IEwRibbonQuickAccessControlX
IEwRibbonTabX
IEwRibbonX
IEwRightsManagerX
IEwSaveDWGImageX
IEwSymbolCircuitX
IEwSymbolFiltersX
IEwSymbolManagerX
IEwSymbolPointX
IEwSymbolX
IEwTerminalTypeManagerX
IEwTitleBlockManagerX
IEwTitleBlockX
IEwWireTerminationTypeManagerX
IEwXLSBookX
IEwXLSSheetX
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  2022.0.0
Electrical API
Public Member Functions | List of all members
IEwLibraryX Interface Reference

Use this interface to manage an EwLibraryX object. More...

Inheritance diagram for IEwLibraryX:
[legend]

Public Member Functions

EwErrorCode setName (BSTR strName)
 set the name of library More...
 
BSTR getName (EwErrorCode *errorCode)
 return name of current Library More...
 
EwErrorCode setDescription (BSTR strLgCode, BSTR strVal)
 set a description of Library More...
 
BSTR getDescription (BSTR strLgCode, EwErrorCode *errorCode)
 return a description of language parameter More...
 
DATE getModificationDate (EwErrorCode *errorCode)
 return a modification date of current library More...
 
DATE getCreationDate (EwErrorCode *errorCode)
 return a creation date of current library More...
 
EwCreatorType getEwCreator (EwErrorCode *errorCode)
 return a creator of current Library More...
 
EwErrorCode setVersionNumber (LONG lValueId)
 set a version Number of current Library More...
 
LONG getVersionNumber (EwErrorCode *errorCode)
 get a version of current Library More...
 
EwErrorCode insert ()
 
EwErrorCode remove ()
 
EwErrorCode update ()
 
EwErrorCode setEwLibContentType (EwLibContentType eLibContentType)
 set a content type of current Library More...
 
EwLibContentType getEwLibContentType (EwErrorCode *errorCode)
 return content type of current Library More...
 
long getId ()
 
BSTR getModifiedBy (EwErrorCode *eErrorCode)
 Get the last user name that modified the current 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...
 
BSTR getCreatedBy (EwErrorCode *eErrorCode)
 Get the user name that created the current object. More...
 

Detailed Description

Use this interface to manage an EwLibraryX object.

Since
2020 SP0

Member Function Documentation

◆ getCreatedBy()

BSTR IEwLibraryX::getCreatedBy ( EwErrorCode *  eErrorCode)

Get the user name that created the current object.

Since
2021
Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred
Returns
a string with the user name that created the current object

◆ getCreationDate()

DATE IEwLibraryX::getCreationDate ( EwErrorCode *  errorCode)

return a creation date of current library

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred
Returns
creationDate the creation date of current library

◆ getDescription()

BSTR IEwLibraryX::getDescription ( BSTR  strLgCode,
EwErrorCode *  errorCode 
)

return a description of language parameter

Parameters
[in]strLgCodelanguage of description to return
[out]strValthe description of library by language.
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_BAD_INPUTS if the code language name is not found

◆ getEwCreator()

EwCreatorType IEwLibraryX::getEwCreator ( EwErrorCode *  errorCode)

return a creator of current Library

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred
Returns
the creator of current library

◆ getEwLibContentType()

EwLibContentType IEwLibraryX::getEwLibContentType ( EwErrorCode *  errorCode)

return content type of current Library

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred
Returns
applicationType Application type of current Library

◆ getId()

long IEwLibraryX::getId ( )
Returns
id of current Library

◆ getModificationDate()

DATE IEwLibraryX::getModificationDate ( EwErrorCode *  errorCode)

return a modification date of current library

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred
Returns
modificationDate date of current library

◆ getModifiedBy()

BSTR IEwLibraryX::getModifiedBy ( EwErrorCode *  eErrorCode)

Get the last user name that modified the current object.

Since
2020 SP0
Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred
Returns
a string with the user name that modified the current object

◆ getName()

BSTR IEwLibraryX::getName ( EwErrorCode *  errorCode)

return name of current Library

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

◆ getTranslatedData()

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

Get the value of a translated text.

Since
2020 SP1
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
Returns
Value of the text to get

◆ getVersionNumber()

LONG IEwLibraryX::getVersionNumber ( EwErrorCode *  errorCode)

get a version of current Library

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred
Returns
a version of current library

◆ insert()

EwErrorCode IEwLibraryX::insert ( )

◆ remove()

EwErrorCode IEwLibraryX::remove ( )

◆ setDescription()

EwErrorCode IEwLibraryX::setDescription ( BSTR  strLgCode,
BSTR  strVal 
)

set a description of Library

Parameters
[in]strLgCodelanguage to change description
[in]strValValue of description
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_BAD_INPUTS if the code language name is not found

◆ setEwLibContentType()

EwErrorCode IEwLibraryX::setEwLibContentType ( EwLibContentType  eLibContentType)

set a content type of current Library

Parameters
[in]eLibContentTypeapplication type to apply
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred

◆ setName()

EwErrorCode IEwLibraryX::setName ( BSTR  strName)

set the name of library

Parameters
[in]strNamename of library
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred

◆ setTranslatedData()

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

Set the value of a translated text.

Since
2020 SP1
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

◆ setVersionNumber()

EwErrorCode IEwLibraryX::setVersionNumber ( LONG  lValueId)

set a version Number of current Library

Parameters
[in]lValueIdversion of library
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred

◆ update()

EwErrorCode IEwLibraryX::update ( )
Generated on Wed Aug 18 2021 10:34:10 for SOLIDWORKS Electrical API by   doxygen 1.8.18


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: IEwLibraryX 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) 2022 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