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
Collapse Class ListClass List
Expand _DIEwProjectXEvents_DIEwProjectXEvents
Expand IEwAddInIEwAddIn
Expand IEwAPIXIEwAPIX
IEwApplicationReactorX
Expand IEwApplicationSettingsXIEwApplicationSettingsX
Expand IEwApplicationXIEwApplicationX
Expand IEwArchiveEnvironmentXIEwArchiveEnvironmentX
Expand IEwCableCoreXIEwCableCoreX
Expand IEwCableReferenceManagerXIEwCableReferenceManagerX
Expand IEwCableReferenceXIEwCableReferenceX
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 IEwEnvironmentXIEwEnvironmentX
Expand IEwInteropFactoryXIEwInteropFactoryX
Expand IEwLibraryManagerXIEwLibraryManagerX
Expand IEwLibraryXIEwLibraryX
Expand IEwLockStringXIEwLockStringX
Expand IEwManufacturerPartCircuitXIEwManufacturerPartCircuitX
Expand IEwManufacturerPartManagerXIEwManufacturerPartManagerX
Expand IEwManufacturerPartTerminalXIEwManufacturerPartTerminalX
Expand IEwManufacturerPartXIEwManufacturerPartX
Expand IEwObjectBaseXIEwObjectBaseX
Expand IEwPointXIEwPointX
Expand IEwProjectAutomaticArrowsXIEwProjectAutomaticArrowsX
Expand IEwProjectBookManagerXIEwProjectBookManagerX
IEwProjectBookX
Expand IEwProjectCableManagerXIEwProjectCableManagerX
Expand IEwProjectCableXIEwProjectCableX
Expand IEwProjectComponentCircuitXIEwProjectComponentCircuitX
Expand IEwProjectComponentManagerXIEwProjectComponentManagerX
IEwProjectComponentTerminalX
Expand IEwProjectComponentXIEwProjectComponentX
Expand IEwProjectConfigurationXIEwProjectConfigurationX
Expand IEwProjectEntity3DManagerXIEwProjectEntity3DManagerX
Expand IEwProjectEntity3DXIEwProjectEntity3DX
Expand IEwProjectExcelAutomationXIEwProjectExcelAutomationX
Expand IEwProjectExportDWGFilesXIEwProjectExportDWGFilesX
Expand IEwProjectExportPDFXIEwProjectExportPDFX
Expand IEwProjectExportPDMXIEwProjectExportPDMX
Expand IEwProjectExportReportXIEwProjectExportReportX
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 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 IEwRibbonControlXIEwRibbonControlX
Expand IEwRibbonGroupXIEwRibbonGroupX
Expand IEwRibbonTabXIEwRibbonTabX
Expand IEwRibbonXIEwRibbonX
Expand IEwRightsManagerXIEwRightsManagerX
Expand IEwSymbolCircuitXIEwSymbolCircuitX
Expand IEwSymbolFiltersXIEwSymbolFiltersX
Expand IEwSymbolManagerXIEwSymbolManagerX
Expand IEwSymbolPointXIEwSymbolPointX
Expand IEwSymbolXIEwSymbolX
Expand IEwTitleBlockManagerXIEwTitleBlockManagerX
Expand IEwTitleBlockXIEwTitleBlockX
Expand IEwXLSBookXIEwXLSBookX
Expand IEwXLSSheetXIEwXLSSheetX
Class Index
Expand Class HierarchyClass Hierarchy
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
IEwArchiveEnvironmentX Interface Reference

Use this interface to manage the archive environment with options. More...

Inheritance diagram for IEwArchiveEnvironmentX:
[legend]

Public Member Functions

EwErrorCode setArchivePath (BSTR strArchivePath)
 Set the path of the destination file where the archive will be done. More...
 
BSTR getArchivePath (EwErrorCode *errorCode)
 Get the archive path combined with the timestamp and the path given by user. More...
 
EwErrorCode setTimeStamp (EwTimeStamp eTimeStamp)
 Set the time stamp that will be added to the filename of the archive file when calling archive method. More...
 
EwTimeStamp getTimeStamp (EwErrorCode *errorCode)
 Get the time stamp that will be added to the filename of the archive file when calling archive method. More...
 
EwErrorCode setArchiveMode (EwArchiveMode eArchiveMode)
 Set the Archive mode. More...
 
EwArchiveMode getArchiveMode (EwErrorCode *errorCode)
 Get the Archive mode. More...
 
EwErrorCode setDate (DATE archiveDate)
 Set the date for archive. More...
 
DATE getDate (EwErrorCode *errorCode)
 Get the date for archive. More...
 
EwErrorCode archive ()
 Archive the current environment. More...
 
EwErrorCode setLibraries (VARIANT vLibrariesArray)
 Set libraries to archive and object associated. More...
 
VARIANT getLibraries (EwErrorCode *errorCode)
 Get libraries to archive in EwArchiveMode::kArchiveModeObjectFromLibrary mode. More...
 
VARIANT_BOOL getArchiveProject (EwErrorCode *errorCode)
 Get option for archiving projects. More...
 
EwErrorCode setArchiveProject (VARIANT_BOOL bArchiveProject)
 Set option for archiving projects. More...
 

Detailed Description

Use this interface to manage the archive environment with options.

For instance, you can specify a start date that will be used to archive all elements with a greater modification date.

Since
2018 SP0

Member Function Documentation

◆ archive()

EwErrorCode IEwArchiveEnvironmentX::archive ( )

Archive the current environment.

Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected.
  • EW_NO_DATA if they are no data to archive.
  • EW_CAN_NOT_WRITE A file exist on output path or other error of archiving.
  • EW_FOLDER_NOT_FOUND if the output folder path does not exist.
  • EW_NO_WRITE_PERMISSION if the directory to archive is in read only.
Since
2020 SP1
  • EW_UNDEFINED_ERROR if another error occurred.

◆ getArchiveMode()

EwArchiveMode IEwArchiveEnvironmentX::getArchiveMode ( EwErrorCode *  errorCode)

Get the Archive mode.

Parameters
[out]EwErrorCodeenum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred
Returns
EwArchiveMode enum type.

◆ getArchivePath()

BSTR IEwArchiveEnvironmentX::getArchivePath ( EwErrorCode *  errorCode)

Get the archive path combined with the timestamp and the path given by user.

Parameters
[out]EwErrorCodeenum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred
Returns
the archive path combined with the timestamp and the path given by user.

◆ getArchiveProject()

VARIANT_BOOL IEwArchiveEnvironmentX::getArchiveProject ( EwErrorCode *  errorCode)

Get option for archiving projects.

Since
2020 SP0
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred
a boolean, false if projects are excluded and true if they are allowed in archive

◆ getDate()

DATE IEwArchiveEnvironmentX::getDate ( EwErrorCode *  errorCode)

Get the date for archive.

This date will be used to select only the elements that have a modification date greater than this date.

Parameters
[out]EwErrorCodeenum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred
Returns
the date to start the archive to now.

◆ getLibraries()

VARIANT IEwArchiveEnvironmentX::getLibraries ( EwErrorCode *  errorCode)

Get libraries to archive in EwArchiveMode::kArchiveModeObjectFromLibrary mode.

Since
2019
Parameters
[out]EwErrorCodeenum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred
Returns
libraries to archive

◆ getTimeStamp()

EwTimeStamp IEwArchiveEnvironmentX::getTimeStamp ( EwErrorCode *  errorCode)

Get the time stamp that will be added to the filename of the archive file when calling archive method.

Parameters
[out]EwErrorCodeenum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred
Returns
an EwTimeStamp enum type.

◆ setArchiveMode()

EwErrorCode IEwArchiveEnvironmentX::setArchiveMode ( EwArchiveMode  eArchiveMode)

Set the Archive mode.

kArchiveModeAllObjects by default.

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

◆ setArchivePath()

EwErrorCode IEwArchiveEnvironmentX::setArchivePath ( BSTR  strArchivePath)

Set the path of the destination file where the archive will be done.

It must be a valid folder. File title will be formatted when calling archive method, it will be the concatenation of the file title and the timestamp if a filestamp is defined.

Parameters
[in]strArchivePathPath where archive will be created
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_FOLDER_NOT_FOUND if the output folder path does not exist
  • EW_UNDEFINED_ERROR if another error occurred

◆ setArchiveProject()

EwErrorCode IEwArchiveEnvironmentX::setArchiveProject ( VARIANT_BOOL  bArchiveProject)

Set option for archiving projects.

If option is activated projects will be archived according with others archive mode if not projects will not be archived

Since
2020 SP0
Parameters
[in]bArchiveProjectvalue of new option true for archiving projects
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred

◆ setDate()

EwErrorCode IEwArchiveEnvironmentX::setDate ( DATE  archiveDate)

Set the date for archive.

This date will be used to select only the elements that have a modification date greater than this date.

Parameters
[in]archiveDateThe start date used to archive elements modified until now.
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred

◆ setLibraries()

EwErrorCode IEwArchiveEnvironmentX::setLibraries ( VARIANT  vLibrariesArray)

Set libraries to archive and object associated.

Available only in EwArchiveMode::kArchiveModeObjectFromLibrary mode.

Since
2019
Parameters
[in]vLibrariesArrayan array of libraries.
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_BAD_INPUTS if aLibrariesArray is not a VARIANT ARRAY containing BSTR
  • EW_UNDEFINED_ERROR if another error occurred

◆ setTimeStamp()

EwErrorCode IEwArchiveEnvironmentX::setTimeStamp ( EwTimeStamp  eTimeStamp)

Set the time stamp that will be added to the filename of the archive file when calling archive method.

Parameters
[in]eTimeStampan EwTimeStamp enum type.
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred
Generated on Thu Aug 20 2020 08:40:16 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: IEwArchiveEnvironmentX 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.46