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
Expand 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
IEwEnvironmentX Interface Reference

Use this interface to manage software environment. More...

Inheritance diagram for IEwEnvironmentX:
Inheritance graph
[legend]

Public Member Functions

EwErrorCode setWorkingFolder (BSTR strFolderPath)
 Set the working folder of this environment. More...
 
EwErrorCode create (BSTR strFolderPath, VARIANT_BOOL bAutoConnect)
 Create a new environment. More...
 
EwErrorCode connect ()
 Connect to environment previously identify by the function setWorkingFolder. More...
 
void disconnect ()
 Disconnect from environment previously connected to. More...
 
IEwManufacturerPartManagerX getEwManufacturerPartManager (EwErrorCode *errorCode)
 get IEwManufacturerPartManagerX of the current environment More...
 
IEwCableReferenceManagerX getEwCableReferenceManager (EwErrorCode *errorCode)
 get EwCableReferenceManager of the current environment More...
 
EwErrorCode archive (BSTR strArchivePath, VARIANT_BOOL bDelete)
 Archive the current data folder in a tewzip file. More...
 
EwErrorCode unarchive (BSTR strArchivePath, BSTR strOutputFolderPath)
 Unarchive a tewzip archive. More...
 
EwErrorCode setDebugInfoType (EwLogOutputType eLogOutputType)
 Modify the output type to display log in, default value is kLogOutputNone: for No error shown. More...
 
EwErrorCode deleteWorkingDirectory ()
 Delete the current working directory. More...
 
IEwTitleBlockManagerX getEwTitleBlockManager (EwErrorCode *errorCode)
 get EwTitleBlockManager of the current environment More...
 
BSTR getSOLIDWORKSFolderPath ()
 Return SOLIDWORKS folder path where SOLIDWORKS files are stored. More...
 
IEwLibraryManagerX getEwLibraryManager (EwErrorCode *errorCode)
 get EwLibraryManager of the current environment More...
 
IEwSymbolManagerX getEwSymbolManager (EwErrorCode *errorCode)
 get IEwSymbolManagerX of the current environment More...
 
BSTR getCreoFolderPath (EwErrorCode *errorCode)
 
BSTR getWorkingFolder (EwErrorCode *errorCode)
 Return environment folder path. More...
 
VARIANT_BOOL getCopy3DParts (EwErrorCode *errorCode)
 
BSTR getCreoTemplateFolderPath ()
 
BSTR getFolderPath (EwEnvironmentFolderPathValue eEnvironmentFolderPathValue, EwErrorCode *errorCode)
 Return folder path associated to enumeration type EwEnvironmentFolderPathValue. More...
 
IEwProjectManagerX getEwProjectManager (EwErrorCode *errorCode)
 get EwProjectManager of the current environment More...
 
BSTR getVersion ()
 
EwErrorCode unarchiveEnvironment (BSTR *strArchivePath)
 Unarchive a tewzip file without showing any dialog, using default options. More...
 
EwErrorCode setHostname (BSTR strHostname)
 Set the hostname to connect to database. More...
 
BSTR getHostname (EwErrorCode *errorCode)
 Get the hostname of database. More...
 
EwErrorCode setUserID (BSTR strUserID)
 Set the user ID to connect to database. More...
 
BSTR getUserID (EwErrorCode *errorCode)
 Get the user ID to connect to database. More...
 
EwErrorCode setPassword (BSTR strPassword)
 Set the password to connect to database. More...
 
BSTR getPassword (EwErrorCode *errorCode)
 Get the password to connect to database. More...
 
IEwProjectManagerX getEwMacroManager (EwErrorCode *errorCode)
 Get a project manager object for macros, macro manager. More...
 
IEwClassificationManagerX getEwClassificationManager (EwErrorCode *errorCode)
 Get a manager object for classifications. More...
 
IEwArchiveEnvironmentX getEwArchiveEnvironment (EwErrorCode *errorCode)
 Get a EwArchiveEnvironmentX object to archive the current environment;. More...
 
IEwWireTerminationTypeManagerX getEwWireTerminationTypeManager (EwErrorCode *errorCode)
 Get IEwWireTerminationTypeManagerX of the current environment. More...
 
IEwTerminalTypeManagerX getEwTerminalTypeManager (EwErrorCode *errorCode)
 Get IEwTerminalTypeManagerX of the current environment. More...
 
BSTR getXMLConfigFolder (EwXMLConfigFolderType eXMLConfigFolderType, EwErrorCode *errorCode)
 Return XML config folder path of configuration. More...
 
BSTR getLogFilePath (EwErrorCode *errorCode)
 Return the path of logfile for query errors. More...
 

Detailed Description

Use this interface to manage software environment.

Since
2018 SP0

Member Function Documentation

◆ archive()

EwErrorCode IEwEnvironmentX::archive ( BSTR  strArchivePath,
VARIANT_BOOL  bDelete 
)

Archive the current data folder in a tewzip file.

Not usable if environment is connected to a SQL Server database

Parameters
[in]strArchivePathPath where archive will be created
[in]bDeleteIf true delete the working directory
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_BAD_INPUTS bad export file path name
  • EW_CAN_NOT_WRITE A file exist on strArchivePath
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_CONNECTIONTYPE You cannot archive an environment connected to a SQL Server database
  • Error from deleteWorkingDirectory

◆ connect()

EwErrorCode IEwEnvironmentX::connect ( )

Connect to environment previously identify by the function setWorkingFolder.

Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_CAN_NOT_WRITE if it's impossible to write/lock the parent working folder
  • EW_DATABASE_CONNECTION_ERROR if it's impossible to create database
  • EW_UNDEFINED_ERROR if another error occurred

◆ create()

EwErrorCode IEwEnvironmentX::create ( BSTR  strFolderPath,
VARIANT_BOOL  bAutoConnect 
)

Create a new environment.

Parameters
[in]strFolderPathThe path to the working folder of this environment, must be a valid empty folder
[in]bAutoConnectTrue if you want to connect directly to the created environment
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_CAN_NOT_WRITE if it's impossible to write/lock the parent working folder
  • EW_DATABASE_CREATION_ERROR if it's impossible to create database
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_BAD_INPUTS if folder path is empty
  • connect() error code if you use auto connect

◆ deleteWorkingDirectory()

EwErrorCode IEwEnvironmentX::deleteWorkingDirectory ( )

Delete the current working directory.

Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_CAN_NOT_WRITE An error occurred during the delete process
  • EW_FOLDER_NOT_FOUND if no working directory exist
  • EW_UNDEFINED_ERROR if another error occurred

◆ disconnect()

void IEwEnvironmentX::disconnect ( )

Disconnect from environment previously connected to.

◆ getCopy3DParts()

VARIANT_BOOL IEwEnvironmentX::getCopy3DParts ( EwErrorCode *  errorCode)
Returns
True if the config allows to copy 3D parts in project folder

◆ getCreoFolderPath()

BSTR IEwEnvironmentX::getCreoFolderPath ( EwErrorCode *  errorCode)
Warning
This interface is deprecated, it returns EW_NOT_IMPLEMENTED
Returns
EW_NOT_IMPLEMENTED

◆ getCreoTemplateFolderPath()

BSTR IEwEnvironmentX::getCreoTemplateFolderPath ( )
Warning
This interface is deprecated, it returns EW_NOT_IMPLEMENTED
Returns
EW_NOT_IMPLEMENTED

◆ getEwArchiveEnvironment()

IEwArchiveEnvironmentX IEwEnvironmentX::getEwArchiveEnvironment ( EwErrorCode *  errorCode)

Get a EwArchiveEnvironmentX object to archive the current environment;.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred
Returns
the application archive environnment interface

◆ getEwCableReferenceManager()

IEwCableReferenceManagerX IEwEnvironmentX::getEwCableReferenceManager ( EwErrorCode *  errorCode)

get EwCableReferenceManager of the current environment

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_NO_ENVIRONMENT_AVAILABLE no environment available
  • EW_UNDEFINED_ERROR if another error occurred
Returns
EwCableReferenceManager of environment

◆ getEwClassificationManager()

IEwClassificationManagerX IEwEnvironmentX::getEwClassificationManager ( EwErrorCode *  errorCode)

Get a manager object for classifications.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_NO_ENVIRONMENT_AVAILABLE no environment available
  • EW_UNDEFINED_ERROR if another error occurred
Returns
An IEwClassificationManagerX to manage macros classification

◆ getEwLibraryManager()

IEwLibraryManagerX IEwEnvironmentX::getEwLibraryManager ( EwErrorCode *  errorCode)

get EwLibraryManager of the current environment

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_NO_ENVIRONMENT_AVAILABLE no environment available
  • EW_UNDEFINED_ERROR if another error occurred
Returns
EwLibraryManager of environment

◆ getEwMacroManager()

IEwProjectManagerX IEwEnvironmentX::getEwMacroManager ( EwErrorCode *  errorCode)

Get a project manager object for macros, macro manager.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_NO_ENVIRONMENT_AVAILABLE no environment available
  • EW_UNDEFINED_ERROR if another error occurred
Returns
An IEwMacroManagerX to manage macros of current environment

◆ getEwManufacturerPartManager()

IEwManufacturerPartManagerX IEwEnvironmentX::getEwManufacturerPartManager ( EwErrorCode *  errorCode)

get IEwManufacturerPartManagerX of the current environment

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_NO_ENVIRONMENT_AVAILABLE no environment available
  • EW_UNDEFINED_ERROR if another error occurred
Returns
an IEwManufacturerPartManagerX of environment

◆ getEwProjectManager()

IEwProjectManagerX IEwEnvironmentX::getEwProjectManager ( EwErrorCode *  errorCode)

get EwProjectManager of the current environment

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_NO_ENVIRONMENT_AVAILABLE no environment available
  • EW_UNDEFINED_ERROR if another error occurred
Returns
EwProjectManager of environment

◆ getEwSymbolManager()

IEwSymbolManagerX IEwEnvironmentX::getEwSymbolManager ( EwErrorCode *  errorCode)

get IEwSymbolManagerX of the current environment

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_NO_ENVIRONMENT_AVAILABLE no environment available
  • EW_UNDEFINED_ERROR if another error occurred
Returns
IEwSymbolManagerX of environment

◆ getEwTerminalTypeManager()

IEwTerminalTypeManagerX IEwEnvironmentX::getEwTerminalTypeManager ( EwErrorCode *  errorCode)

Get IEwTerminalTypeManagerX of the current environment.

Since
2022 SP0
Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_NO_ENVIRONMENT_AVAILABLE no environment available
  • EW_UNDEFINED_ERROR if another error occurred
Returns
IEwTerminalTypeManagerX of environment

◆ getEwTitleBlockManager()

IEwTitleBlockManagerX IEwEnvironmentX::getEwTitleBlockManager ( EwErrorCode *  errorCode)

get EwTitleBlockManager of the current environment

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_NO_ENVIRONMENT_AVAILABLE no environment available
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_CANNOT_REMOVE can not remove environement folder
Returns
EwTitleBlockManager of environment

◆ getEwWireTerminationTypeManager()

IEwWireTerminationTypeManagerX IEwEnvironmentX::getEwWireTerminationTypeManager ( EwErrorCode *  errorCode)

Get IEwWireTerminationTypeManagerX of the current environment.

Since
2022 SP0
Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_NO_ENVIRONMENT_AVAILABLE no environment available
  • EW_UNDEFINED_ERROR if another error occurred
Returns
IEwWireTerminationTypeManagerX of environment

◆ getFolderPath()

BSTR IEwEnvironmentX::getFolderPath ( EwEnvironmentFolderPathValue  eEnvironmentFolderPathValue,
EwErrorCode *  errorCode 
)

Return folder path associated to enumeration type EwEnvironmentFolderPathValue.

Parameters
[in]eEnvironmentFolderPathValueEnumeration type to get the associated folder path
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_OUT_OF_SCOPE the value of EwEnvironmentFolderPathValue is out of the scope of the values managed by this method
  • EW_UNDEFINED_ERROR if another error occurred
Returns
Corresponding folder path with last backslash

◆ getHostname()

BSTR IEwEnvironmentX::getHostname ( EwErrorCode *  errorCode)

Get the hostname of database.

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

◆ getLogFilePath()

BSTR IEwEnvironmentX::getLogFilePath ( EwErrorCode *  errorCode)

Return the path of logfile for query errors.

Since
2022 SP1.
Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_NO_ENVIRONMENT_AVAILABLE no environment available
  • EW_UNDEFINED_ERROR if another error occurred
Returns
the path of logfile for query errors.

◆ getPassword()

BSTR IEwEnvironmentX::getPassword ( EwErrorCode *  errorCode)

Get the password to connect to database.

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

◆ getSOLIDWORKSFolderPath()

BSTR IEwEnvironmentX::getSOLIDWORKSFolderPath ( )

Return SOLIDWORKS folder path where SOLIDWORKS files are stored.

Returns
Folder path for SOLIDWORKS files with last backslash

◆ getUserID()

BSTR IEwEnvironmentX::getUserID ( EwErrorCode *  errorCode)

Get the user ID to connect to database.

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

◆ getVersion()

BSTR IEwEnvironmentX::getVersion ( )
Returns
the full version string without build number example: 2016.0.2

◆ getWorkingFolder()

BSTR IEwEnvironmentX::getWorkingFolder ( EwErrorCode *  errorCode)

Return environment folder path.

Returns
Folder path for all files with last backslash

◆ getXMLConfigFolder()

BSTR IEwEnvironmentX::getXMLConfigFolder ( EwXMLConfigFolderType  eXMLConfigFolderType,
EwErrorCode *  errorCode 
)

Return XML config folder path of configuration.

Since
2022 SP0
Parameters
[in]eXMLConfigFolderTypeEwXMLConfigFolderType enum type of path
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_NO_ENVIRONMENT_AVAILABLE no environment available
  • EW_UNDEFINED_ERROR if another error occurred
Returns
XML config folder path of configuration

◆ setDebugInfoType()

EwErrorCode IEwEnvironmentX::setDebugInfoType ( EwLogOutputType  eLogOutputType)

Modify the output type to display log in, default value is kLogOutputNone: for No error shown.

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

◆ setHostname()

EwErrorCode IEwEnvironmentX::setHostname ( BSTR  strHostname)

Set the hostname to connect to database.

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

◆ setPassword()

EwErrorCode IEwEnvironmentX::setPassword ( BSTR  strPassword)

Set the password to connect to database.

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

◆ setUserID()

EwErrorCode IEwEnvironmentX::setUserID ( BSTR  strUserID)

Set the user ID to connect to database.

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

◆ setWorkingFolder()

EwErrorCode IEwEnvironmentX::setWorkingFolder ( BSTR  strFolderPath)

Set the working folder of this environment.

Parameters
[in]strFolderPathThe path to the working folder of this environment
  • EW_UNDEFINED_ERROR if another error occurred
Returns
EW_NO_ERROR if no error detected

◆ unarchive()

EwErrorCode IEwEnvironmentX::unarchive ( BSTR  strArchivePath,
BSTR  strOutputFolderPath 
)

Unarchive a tewzip archive.

Parameters
[in]strArchivePathPath to the tewzip archive you want to unarchive
[in]strOutputFolderPathPath where archive will be extract
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_CAN_NOT_WRITE A file exist on strArchivePath
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_FILE if strArchivePath is not a valid file
  • EW_FOLDER_NOT_FOUND if strArchivePath or strOutputFolderPath doesn't exist
  • EW_FILE_FROM_HIGHER_VERSION If the file is archived from a higher version

◆ unarchiveEnvironment()

EwErrorCode IEwEnvironmentX::unarchiveEnvironment ( BSTR *  strArchivePath)

Unarchive a tewzip file without showing any dialog, using default options.

Parameters
[in]strArchivePathPath to the tewzip file you want to unarchive
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_FILE if strArchivePath is not a valid file
  • EW_FILE_NOT_FOUND if strArchivePath doesn't exist
  • EW_FILE_FROM_HIGHER_VERSION If the file is archived from a higher version
Generated on Thu Aug 25 2022 16:02:38 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: IEwEnvironmentX 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