Welcome
Expand Getting StartedGetting Started
Expand SOLIDWORKS API HelpSOLIDWORKS API Help
Collapse SOLIDWORKS Electrical API HelpSOLIDWORKS Electrical API Help
Expand Getting StartedGetting Started
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
IEwEnvironmentX
IEwInteropFactoryX
IEwLibraryManagerX
IEwLibraryX
IEwLockStringX
IEwManufacturerPartCircuitX
IEwManufacturerPartManagerX
IEwManufacturerPartTerminalX
IEwManufacturerPartX
Expand IEwObjectBaseXIEwObjectBaseX
IEwPointX
IEwProjectAutomaticArrowsX
IEwProjectBookManagerX
IEwProjectCableManagerX
IEwProjectComponentCircuitX
IEwProjectComponentManagerX
IEwProjectComponentTerminalX
IEwProjectEntity3DManagerX
IEwProjectExportDWGFilesX
IEwProjectExportPDMX
IEwProjectExportReportX
IEwProjectFileManagerX
IEwProjectFolderManagerX
IEwProjectFunctionManagerX
IEwProjectGenerateTSDrawingX
IEwProjectHarnessManagerX
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
Hide Table of Contents
SOLIDWORKS Electrical API  2020.0.5
Electrical API
Public Member Functions | List of all members
IEwProjectFileManagerX Interface Reference

Use this interface to manage EwProjectFileManagerx objects. More...

Inheritance diagram for IEwProjectFileManagerX:
[legend]

Public Member Functions

INT_PTR getCount (EwErrorCode *errorCode)
 Return the number of files of associated project. More...
 
VARIANT getEwProjectFileArray (EwErrorCode *errorCode)
 Return the array of IEwProjectFile of associated project. More...
 
IEwProjectFileX findEwProjectFileByID (LONG lEwProjectFileID, EwErrorCode *errorCode)
 Get the EwProjectFile from the file ID, for associated project. More...
 
IEwProjectFileX findEwProjectFileFromPath (BSTR strFilePath, EwErrorCode *errorCode)
 Get the EwProjectFile from a file path. More...
 
VARIANT getEwProjectFileArrayFromFileType (EwFileType eFileType, EwErrorCode *errorCode)
 Return the array of IEwProjectFileX of given type for associated project. More...
 
IEwProjectFileX newProjectFile (EwErrorCode *errorCode)
 Create an IEwProjectFileX in the current project. More...
 

Detailed Description

Use this interface to manage EwProjectFileManagerx objects.

Since
2018 SP0

Member Function Documentation

◆ findEwProjectFileByID()

IEwProjectFileX IEwProjectFileManagerX::findEwProjectFileByID ( LONG  lEwProjectFileID,
EwErrorCode *  errorCode 
)

Get the EwProjectFile from the file ID, for associated project.

Parameters
[in]lEwProjectFileIDFile ID
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_INVALID_FILE The file with given ID not exists in the active project
  • EW_UNDEFINED_ERROR if another error occurred
Returns
Valid EwProjectFile object if the file is founded. NULL otherwise

◆ findEwProjectFileFromPath()

IEwProjectFileX IEwProjectFileManagerX::findEwProjectFileFromPath ( BSTR  strFilePath,
EwErrorCode *  errorCode 
)

Get the EwProjectFile from a file path.

If the file doesn't belong to the associated project it will returns NULL object.

Parameters
[in]strFilePathFull file path
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_FILE_NOT_FOUND The file path does not exist
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_INVALID_NAME if name of file is empty
Returns
Valid EwProjectFile object if the file is founded. NULL otherwise

◆ getCount()

INT_PTR IEwProjectFileManagerX::getCount ( EwErrorCode *  errorCode)

Return the number of files of associated project.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred
Returns
the number of file of associated project

◆ getEwProjectFileArray()

VARIANT IEwProjectFileManagerX::getEwProjectFileArray ( EwErrorCode *  errorCode)

Return the array of IEwProjectFile of associated project.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred
Returns
the array of IEwProjectFile of associated project

◆ getEwProjectFileArrayFromFileType()

VARIANT IEwProjectFileManagerX::getEwProjectFileArrayFromFileType ( EwFileType  eFileType,
EwErrorCode *  errorCode 
)

Return the array of IEwProjectFileX of given type for associated project.

Parameters
[in]eFileTypeEwFileType File type enum, to return all files of given type.
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred
  • EW_CANNOT_INITIALIZE if envirenement is not initialise
Returns
the array of IEwProjectFile of associated project

◆ newProjectFile()

IEwProjectFileX IEwProjectFileManagerX::newProjectFile ( EwErrorCode *  errorCode)

Create an IEwProjectFileX in the current project.

Only Folio, Line Diagram, Cover page, Mixed, AppendixDwg, Shortcut or Other file types can be used.

Since
2020 SP0
Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_PROJECT_NOTOPENED Project not opened
  • EW_UNDEFINED_ERROR if another error occurred
Returns
A valid IEwProjectFileX object
Generated on Tue Sep 1 2020 17:01:24 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: IEwProjectFileManagerX 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) 2020 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