Hide Table of Contents
UndoLockFile Method (IEdmFile5)

Removes the check-out of a file without saving changes to the archive.

Syntax

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

Parameters

lParentWnd
Parent window handle
bGetLatestVersion
Optional; true to replace the local copy of the file with the latest from the archive, false to not; default is true

Example

Remarks

Before calling this method, the file must be checked out by the logged-in user.

IEdmBatchUnlock is more efficient than this interface for undoing the check-outs of multiple files.

Return codes:

  • S_OK: The method successfully executed.
  • E_EDM_FILE_NOT_LOCKED_BY_YOU: The file is not checked out or is checked out by another user.
  • E_EDM_LOCKED_ON_OTHER_COMPUTER: The file is not checked out on the client machine where you ran this method.
  • E_EDM_OPERATION_REFUSED_BY_PLUGIN: One of the loaded EdmCmdType.EdmCmd_PreUndoLock hooks did not permit the operation.
  • E_EDM_PERMISSION_DENIED: Undoing the check-out of this file is not permitted. You cannot undo the check-out of a file before it has been checked in at least once.
 

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:   UndoLockFile Method (IEdmFile5)
*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.