<xml> </xml>

SOLIDWORKS PDM Professional API Help | Send Feedback
UndoLockFile Method (IEdmFile5)
See Also Example

Collapse All Expand All Language Filter: All Language Filter: Multiple Language Filter: Visual Basic Language Filter: C# Language Filter: C++/CLI

EPDM.Interop.epdm Namespace > IEdmFile5 Interface : UndoLockFile Method (IEdmFile5)

Visual Basic
C#
C++/CLI

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

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

# Syntax

Visual Basic |
--- | ---

    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

Access File Card Variables (VB.NET)
Access File Card Variables (C#)

# 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.

See Return Codes for the complete list of potential success and error codes. The following are just a few examples:

- 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

####

IEdmFile5 Interface
IEdmFile5 Members
IEdmFile5::UnlockFile Method ()
IEdmfile5::LockFile Method ()

# Availability

SOLIDWORKS PDM Professional Version 5.2