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
IEwCommandContextX
IEwCommandManagerX
IEwCommandX
IEwDialogAlignPartsParametersSelectorX
IEwDialogLocationSelectorX
IEwDialogMacroSelectorX
IEwDialogManufacturerPartOrderingX
IEwDialogManufacturerPartSelectorX
IEwDialogProgressX
IEwDialogProjectManagerX
IEwDialogResumeX
IEwDialogSummaryX
IEwDialogTaskX
IEwDockingPaneManagerX
IEwDockingPaneX
IEwEnvironmentX
IEwInteropFactoryX
IEwLibraryManagerX
IEwLibraryX
IEwLockStringX
IEwManufacturerPartCircuitX
IEwManufacturerPartManagerX
IEwManufacturerPartTerminalX
IEwManufacturerPartX
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
IEwRibbonControlX
IEwRibbonGroupX
IEwRibbonTabX
IEwRibbonX
IEwRightsManagerX
IEwSymbolCircuitX
IEwSymbolFiltersX
IEwSymbolManagerX
IEwSymbolPointX
IEwSymbolX
IEwTitleBlockManagerX
IEwTitleBlockX
IEwXLSBookX
IEwXLSSheetX
Expand Class MembersClass Members
Expand SOLIDWORKS PDM Professional API HelpSOLIDWORKS PDM Professional API Help
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 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  2021.0.0
Electrical API
Public Member Functions | List of all members
IEwProjectExcelAutomationX Interface Reference

Use this interface to manage the Excel Automation inside the project. More...

Inheritance diagram for IEwProjectExcelAutomationX:
[legend]

Public Member Functions

EwErrorCode setExcelFilePath (BSTR strExcelFilePath)
 Specify the full path to the Excel file for automation. More...
 
BSTR getExcelFilePath (EwErrorCode *errorCode)
 Return the full path to the Excel file for automation. More...
 
EwErrorCode setGenerateLog (VARIANT_BOOL bGenerateLog)
 Specify if a log file is generated. More...
 
VARIANT_BOOL getGenerateLog (EwErrorCode *errorCode)
 Return True if a log is generated. More...
 
EwErrorCode setLogFilePath (BSTR strLogFilePath)
 Specify the Log file path. More...
 
BSTR getLogFilePath (EwErrorCode *errorCode)
 Return The log file path for Excel automation. More...
 
VARIANT getEwResumeRowXArray (EwErrorCode *errorCode)
 Return an array of EwResumeRowX that contains all Log from the last excel automation launch. More...
 
EwErrorCode doExcelAutomation ()
 Start the Excel Automation. More...
 

Detailed Description

Use this interface to manage the Excel Automation inside the project.

Since
2021 SP0

Member Function Documentation

◆ doExcelAutomation()

EwErrorCode IEwProjectExcelAutomationX::doExcelAutomation ( )

Start the Excel Automation.

Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_FILE_NOT_FOUND if the file does not exist
  • EW_BAD_INPUTS the current project is a Macro not a project.
  • EW_OPERATION_CANCELED An error occur in the Excel Automation process, open log file for more details.
  • EW_UNDEFINED_ERROR if another error occurred

◆ getEwResumeRowXArray()

VARIANT IEwProjectExcelAutomationX::getEwResumeRowXArray ( EwErrorCode *  errorCode)

Return an array of EwResumeRowX that contains all Log from the last excel automation launch.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_BAD_INPUTs if the ewResumeRowXArray return value cannot be initialized.
  • EW_UNDEFINED_ERROR if another error occurred
Returns
an array of EwResumeRowX that contains all Log from the last excel automation launch.

◆ getExcelFilePath()

BSTR IEwProjectExcelAutomationX::getExcelFilePath ( EwErrorCode *  errorCode)

Return the full path to the Excel file for automation.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred
Returns
the Excel file for automation.

◆ getGenerateLog()

VARIANT_BOOL IEwProjectExcelAutomationX::getGenerateLog ( EwErrorCode *  errorCode)

Return True if a log is generated.

False by default.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred
Returns
True if a log is generated.

◆ getLogFilePath()

BSTR IEwProjectExcelAutomationX::getLogFilePath ( EwErrorCode *  errorCode)

Return The log file path for Excel automation.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred
Returns
the Log file for automation.

◆ setExcelFilePath()

EwErrorCode IEwProjectExcelAutomationX::setExcelFilePath ( BSTR  strExcelFilePath)

Specify the full path to the Excel file for automation.

Parameters
[in]strExcelFilePaththe full path to the Excel file.
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_FILE_NOT_FOUND if the file does not exist
  • EW_UNDEFINED_ERROR if another error occurred

◆ setGenerateLog()

EwErrorCode IEwProjectExcelAutomationX::setGenerateLog ( VARIANT_BOOL  bGenerateLog)

Specify if a log file is generated.

False by default.

Parameters
[in]bGenerateLogTrue for generating the log file.
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred

◆ setLogFilePath()

EwErrorCode IEwProjectExcelAutomationX::setLogFilePath ( BSTR  strLogFilePath)

Specify the Log file path.

By default the log file is the Excel file with the ".log" extension and is created next to the Excel file.

Parameters
[in]strLogFilePaththe new Log file path.
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_FOLDER_NOT_FOUND if the folder for the path does not exist
  • EW_UNDEFINED_ERROR if another error occurred
Generated on Thu Aug 20 2020 08:40:17 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: IEwProjectExcelAutomationX 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) 2021 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.23