SOLIDWORKS PDM Professional API Help Send Feedback
DeleteFolder Method (IEdmFolder5)
See Also  Example
EPDM.Interop.epdm Namespace > IEdmFolder5 Interface : DeleteFolder Method (IEdmFolder5)


lParentWnd
Parent window handle
lSubfolderID
ID of folder to delete
bRemoveLocalCopy
Optionally true to remove the folder from the local disk, false to not; default is true
Deletes the specified subfolder from this folder.

Syntax

Visual Basic 
Sub DeleteFolder( _
   ByVal lParentWnd As System.Integer, _
   ByVal lSubfolderID As System.Integer, _
   Optional ByVal bRemoveLocalCopy As System.Boolean _
) 
C# 
void DeleteFolder( 
   System.int lParentWnd,
   System.int lSubfolderID,
   System.bool bRemoveLocalCopy
)
C++/CLI 
void DeleteFolder( 
&   System.int lParentWnd,
&   System.int lSubfolderID,
&   System.bool bRemoveLocalCopy
) 

Parameters

lParentWnd
Parent window handle
lSubfolderID
ID of folder to delete
bRemoveLocalCopy
Optionally true to remove the folder from the local disk, false to not; default is true

Example

Remarks

This method deletes only folders that are empty.

Return codes:

  • S_OK: The method successfully executed.
  • E_EDM_FOLDER_NOT_FOUND: The specified ID is not a subfolder of this folder.
  • E_EDM_OPERATION_REFUSED_BY_PLUGIN: One of the installed EdmCmdData.EdmCmd_PreDeleteFolder hooks did not permit the operation.
  • E_EDM_FOLDER_NOT_EMPTY: The folder cannot be deleted, because it has files or subfolders in it.
  • E_EDM_PERMISSION_DENIED: The user lacks permission to delete the specified folder.
 

See Also

Availability

SOLIDWORKS PDM Professional Version 5.2