Hide Table of Contents
DeleteFile Method (IEdmFolder5)

Deletes a file having the specified ID from this folder.

Syntax

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

Parameters

lParentWnd
Parent window handle
lFileID
ID of file to delete
bRemoveLocalCopy
Optionally, true to erase the local copy of the file, false to not; default is true

Example

Remarks

If the specified file is shared to other folders, it is deleted only from this folder.

Return codes:

  • S_OK: The method successfully executed.
  • E_EDM_FILE_NOT_FOUND: The file ID is invalid.
  • E_EDM_OPERATION_REFUSED_BY_PLUGIN: The operation is not permitted by one of the installed EdmCmdData.EdmCmd_PreDelete hooks.
  • E_EDM_LOCKED_BY_ANOTHER_USER: The file cannot be deleted since it is checked out by another user.
  • E_EDM_PERMISSION_DENIED: The user lacks permission to delete the file.
 

See Also

Availability

SOLIDWORKS PDM Professional Version 5.2


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:   DeleteFile Method (IEdmFolder5)
*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) 2018 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.