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
Collapse 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
IEwProjectFolderX Interface Reference

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

Inheritance diagram for IEwProjectFolderX:
[legend]

Public Member Functions

LONG getEwProjectBookID (EwErrorCode *errorCode)
 Get the ID of the book containing this folder. More...
 
EwErrorCode setEwProjectBookID (LONG lID)
 Update the ID of the book containing this folder. More...
 
LONG getEwProjectFolderID (EwErrorCode *errorCode)
 Get the ID of the folder containing this folder. More...
 
EwErrorCode setEwProjectFolderID (LONG lID)
 Update the folder ID of the parent folder. More...
 
LONG getFirstDrawingNumber (EwErrorCode *errorCode)
 Get the number of the first drawing that will be created in this folder. More...
 
EwErrorCode setFirstDrawingNumber (LONG lID)
 Set the number of the first drawing that will be created in this folder. More...
 
VARIANT_BOOL getDefineFirstDrawingNumber (EwErrorCode *errorCode)
 Return true if the number of the first drawing created in the folder have to be the one defined in setFirstDrawingNumber. More...
 
EwErrorCode setDefineFirstDrawingNumber (VARIANT_BOOL bDefineFirstDrawingNumber)
 Set this value to true to have the number of the first drawing created in this folder initialised by getFirstDrawingNumber. More...
 
LONG getPosition (EwErrorCode *errorCode)
 Get the position of the folder in the book. More...
 
- Public Member Functions inherited from IEwProjectTagObjectX
EwErrorCode setUserData (LONG nUserDataNumber, BSTR strValue)
 Set user data of the object. More...
 
BSTR getUserData (LONG nUserDataNumber, EwErrorCode *errorCode)
 Get user data of the object. More...
 
EwErrorCode setTranslatedData (LONG nUserDataNumber, BSTR strLanguage, BSTR strValue)
 Set the value of a translated text. More...
 
BSTR getTranslatedData (LONG nUserDataNumber, BSTR strLanguage, EwErrorCode *errorCode)
 Get the value of a translated text. More...
 
BSTR getTag (EwErrorCode *errorCode)
 Get the mark of this object. More...
 
EwErrorCode setTag (BSTR strValue)
 Set the mark of this object. More...
 
BSTR getTagRoot (EwErrorCode *errorCode)
 Get the mark root of this object. More...
 
EwErrorCode setTagRoot (BSTR strValue)
 Set the mark root of this object. More...
 
EwTagMode getTagMode (EwErrorCode *errorCode)
 Get the mark mode of this object. More...
 
EwErrorCode setTagMode (EwTagMode eValue)
 Set the mark mode of this object. More...
 
long getTagNumber (EwErrorCode *errorCode)
 Get the mark number of this object. More...
 
EwErrorCode setTagNumber (long lValue)
 Set the mark number of this object. More...
 
EwErrorCode setNextTagNumber ()
 Set the next number to have a unique mark. More...
 
VARIANT_BOOL isTagUnique (EwErrorCode *errorCode)
 Returns true or false if mark is unique. More...
 
- Public Member Functions inherited from IEwObjectBaseX
EwErrorCode remove ()
 Remove the object from the current project. More...
 
EwErrorCode update ()
 Update the object inside the current project. More...
 
LONG getID ()
 

Detailed Description

Use this interface to manage folder inside a project.

Since
2018 SP1

Member Function Documentation

◆ getDefineFirstDrawingNumber()

VARIANT_BOOL IEwProjectFolderX::getDefineFirstDrawingNumber ( EwErrorCode *  errorCode)

Return true if the number of the first drawing created in the folder have to be the one defined in setFirstDrawingNumber.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred
Returns
true if the number of the first drawing created in the folder have to be the one defined in setFirstDrawingNumber.

◆ getEwProjectBookID()

LONG IEwProjectFolderX::getEwProjectBookID ( EwErrorCode *  errorCode)

Get the ID of the book containing this folder.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred
Returns
the ID of the book containing this folder.

◆ getEwProjectFolderID()

LONG IEwProjectFolderX::getEwProjectFolderID ( EwErrorCode *  errorCode)

Get the ID of the folder containing this folder.

If the folder doesn't have parent folder it returns -1.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred
Returns
the ID of the folder containing this folder.

◆ getFirstDrawingNumber()

LONG IEwProjectFolderX::getFirstDrawingNumber ( EwErrorCode *  errorCode)

Get the number of the first drawing that will be created in this folder.

Remark: This number is used only if getDefineFirstDrawingNumber returns true.

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 the first drawing that will be created in this folder.

◆ getPosition()

LONG IEwProjectFolderX::getPosition ( EwErrorCode *  errorCode)

Get the position of the folder in the book.

Parameters
[out]errorCodeEwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred
Returns
the position of the folder in the book.

◆ setDefineFirstDrawingNumber()

EwErrorCode IEwProjectFolderX::setDefineFirstDrawingNumber ( VARIANT_BOOL  bDefineFirstDrawingNumber)

Set this value to true to have the number of the first drawing created in this folder initialised by getFirstDrawingNumber.

Parameters
[in]bDefineFirstDrawingNumberSet this value to true to have the number of the first drawing created in this folder initialised by getFirstDrawingNumber.
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_UNDEFINED_ERROR if another error occurred

◆ setEwProjectBookID()

EwErrorCode IEwProjectFolderX::setEwProjectBookID ( LONG  lID)

Update the ID of the book containing this folder.

Parameters
[in]lIDthe new Book Parent ID.
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_BAD_INPUT if the Parent Book ID is not found in the current project
  • EW_UNDEFINED_ERROR if another error occurred

◆ setEwProjectFolderID()

EwErrorCode IEwProjectFolderX::setEwProjectFolderID ( LONG  lID)

Update the folder ID of the parent folder.

Book ID of the folder will also be updated if the book of the new parent folder is different from the one already define.

Parameters
[in]lIDthe new parent folder ID.
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_BAD_INPUT if the Parent folder ID is not found in the current project
  • EW_UNDEFINED_ERROR if another error occurred

◆ setFirstDrawingNumber()

EwErrorCode IEwProjectFolderX::setFirstDrawingNumber ( LONG  lID)

Set the number of the first drawing that will be created in this folder.

Remark: the number of a drawing is always greater than the previous drawing (regardless of the folder).

Parameters
[in]lIDthe OrderNo of the first drawing into this folder.
Returns
EwErrorCode enum type, can be:
  • EW_NO_ERROR if no error detected
  • EW_BAD_INPUT if getDefineFirstDrawingNumber return false or if lID is smaller than 1.
  • EW_UNDEFINED_ERROR if another error occurred
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: IEwProjectFolderX 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.46