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
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
Expand IEwEXCELImportLibraryXIEwEXCELImportLibraryX
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
Expand IEwProjectBookXIEwProjectBookX
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 IEwProjectLineManagerXIEwProjectLineManagerX
Expand IEwProjectLineXIEwProjectLineX
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 IEwProjectSymbolCircuitXIEwProjectSymbolCircuitX
Expand IEwProjectSymbolManagerXIEwProjectSymbolManagerX
Expand IEwProjectSymbolPointXIEwProjectSymbolPointX
Expand IEwProjectSymbolXIEwProjectSymbolX
Expand IEwProjectTagObjectXIEwProjectTagObjectX
Expand IEwProjectUpdateReplaceDataXIEwProjectUpdateReplaceDataX
Expand IEwProjectWireManagerXIEwProjectWireManagerX
Expand IEwProjectWireStyleBaseIEwProjectWireStyleBase
Expand IEwProjectWireStyleGroupXIEwProjectWireStyleGroupX
Expand IEwProjectWireStyleManagerXIEwProjectWireStyleManagerX
IEwProjectWireStyleSynopticX
Expand IEwProjectWireStyleXIEwProjectWireStyleX
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 SOLIDWORKS Visualize API HelpSOLIDWORKS Visualize 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 2025.0.0
Electrical API
Public Member Functions | List of all members
IEwProjectSnapshotX Interface Reference

Use this interface to manage snapshot inside a project. More...

Inheritance diagram for IEwProjectSnapshotX:

Public Member Functions

EwErrorCode remove ()
 Remove the object from the current project. More...
 
EwErrorCode update ()
 Update the object inside the current project. More...
 
LONG getID ()
 
DATE getCreationDate (EwErrorCode *errorCode)
 Get the creation date of this snapshot object. More...
 
EwErrorCode setName (BSTR strName)
 Set the name of this snapshot. More...
 
BSTR getName (EwErrorCode *errorCode)
 Get the name of this snapshot. More...
 
EwEventCode getEventType (EwErrorCode *errorCode)
 Get the event type of this snapshot. More...
 
long getFileSize (EwErrorCode *errorCode)
 Get the estimate file size in MB of this snapshot. More...
 
BSTR getEventDetails (EwErrorCode *errorCode)
 Get the event details of this snapshot. More...
 
EwErrorCode create ()
 Create a snapshot of the current project. More...
 
EwErrorCode restore ()
 Restore a snapshot of the current project. More...
 
VARIANT_BOOL getGenerateAutomatedDrawings (EwErrorCode *errorCode)
 Option to update all generated files like Terminal strips or Reports which have been added to the project. More...
 
EwErrorCode setGenerateAutomatedDrawings (VARIANT_BOOL bGenerateAutomatedDrawings)
 Option to update all generated files like Terminal strips or Reports which have been added to the project. More...
 
BSTR getDescription (BSTR strLanguage, EwErrorCode *errorCode)
 Get the description associated to the object. More...
 
EwErrorCode setDescription (BSTR strLanguage, BSTR strDescription)
 Set the description associated to the object. More...
 

Detailed Description

Use this interface to manage snapshot inside a project.

Since
2019 SP0

Member Function Documentation

◆ create()

EwErrorCode IEwProjectSnapshotX::create ( )

Create a snapshot of the current project.

The current project must be closed before using this function.

Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_PROJECT_OPENED if project is opened. It must be closed before creating a snapshot.
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_OPERATION_CANCELED if cannote create the snapshot
  • EW_INVALID_OBJECT if object is not initialized

◆ getCreationDate()

DATE IEwProjectSnapshotX::getCreationDate ( EwErrorCode *  errorCode)

Get the creation date of this snapshot object.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if an error occurred
  • EW_INVALID_OBJECT if object is not initialized
Returns
will contain the creation date of this snapshot.

◆ getDescription()

BSTR IEwProjectSnapshotX::getDescription ( BSTR  strLanguage,
EwErrorCode *  errorCode 
)

Get the description associated to the object.

Since
2025 SP1.
Parameters
[in]strLanguageThe language of the description you want to get (like 'en' for english or 'fr' for french )
[out]errorCodeEwErrorCode enum, can be:
  • EW_UNDEFINED_ERROR if another error occurred.
  • EW_INVALID_OBJECT if object base is not initialized.
  • EW_INVALID_OBJECT if current object is not inserted.
  • EW_PROJECT_NOTOPENED if project not opened.
  • EW_BAD_INPUTS if the given language is not found.
  • EW_NO_ERROR if no error detected.

◆ getEventDetails()

BSTR IEwProjectSnapshotX::getEventDetails ( EwErrorCode *  errorCode)

Get the event details of this snapshot.

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 event details of this snapshot.

◆ getEventType()

EwEventCode IEwProjectSnapshotX::getEventType ( EwErrorCode *  errorCode)

Get the event type of this snapshot.

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 event type of this snapshot.

◆ getFileSize()

long IEwProjectSnapshotX::getFileSize ( EwErrorCode *  errorCode)

Get the estimate file size in MB of this snapshot.

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 estimate file size in MB of this snapshot.

◆ getGenerateAutomatedDrawings()

VARIANT_BOOL IEwProjectSnapshotX::getGenerateAutomatedDrawings ( EwErrorCode *  errorCode)

Option to update all generated files like Terminal strips or Reports which have been added to the project.

Default value is true.

Since
2020 SP0
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
Returns true by default, false otherwise.

◆ getID()

LONG IEwProjectSnapshotX::getID ( )
Returns
Get the ID of the object used. -1 if the object is invalid.

◆ getName()

BSTR IEwProjectSnapshotX::getName ( EwErrorCode *  errorCode)

Get the name of this snapshot.

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 name of this snapshot.

◆ remove()

EwErrorCode IEwProjectSnapshotX::remove ( )

Remove the object from the current project.

Returns
EwErrorCode 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 previously created.
  • EW_PROJECT_OPENED if the associated project is not open.
  • EW_FILE_NOT_FOUND if directory associated to the snapshot are not found.

◆ restore()

EwErrorCode IEwProjectSnapshotX::restore ( )

Restore a snapshot of the current project.

Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_FILE_NOT_FOUND if the snapshot zip file is not found.
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT if object is not initialized

◆ setDescription()

EwErrorCode IEwProjectSnapshotX::setDescription ( BSTR  strLanguage,
BSTR  strDescription 
)

Set the description associated to the object.

Since
2025 SP1.
Parameters
[in]strLanguageThe language of the description you want to get (like 'en' for english or 'fr' for french )
[in]strDescriptionThe description to add
Returns
errorCode EwErrorCode enum, can be:
  • EW_UNDEFINED_ERROR if another error occurred.
  • EW_INVALID_OBJECT if object base is not initialized.
  • EW_INVALID_OBJECT if current object is not inserted.
  • EW_PROJECT_NOTOPENED if project not opened.
  • EW_BAD_INPUTS if the given language is not found.
  • EW_BAD_INPUTS if the given description is empty.
  • EW_NO_ERROR if no error detected.

◆ setGenerateAutomatedDrawings()

EwErrorCode IEwProjectSnapshotX::setGenerateAutomatedDrawings ( VARIANT_BOOL  bGenerateAutomatedDrawings)

Option to update all generated files like Terminal strips or Reports which have been added to the project.

Default value is true.

Since
2020 SP0
Parameters
[in]bGenerateAutomatedDrawingscan be true or false. True for update all generated files.
Returns
EwErrorCode 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

◆ setName()

EwErrorCode IEwProjectSnapshotX::setName ( BSTR  strName)

Set the name of this snapshot.

Parameters
[in]strNamesnapshot new name
Returns
EwErrorCode enum type, can be:
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_OBJECT if object is not initialized
  • EW_BAD_INPUTS if only (" ") character fill the name or empty
  • EW_NO_ERROR if no error detected

◆ update()

EwErrorCode IEwProjectSnapshotX::update ( )

Update the object inside the current project.

Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_INVALID_OBJECT if object is not initialized
  • EW_BAD_INPUTS if an input value is not good
Generated 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: IEwProjectSnapshotX 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) 2025 SP2

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