Hide Table of Contents
LockFile Method (IEdmFile5)

Checks out this file from the vault to which the user is currently logged in.

Syntax

Visual Basic (Declaration) 
Sub LockFile( _
   ByVal lParentFolderID As System.Integer, _
   ByVal lParentWnd As System.Integer, _
   Optional ByVal lEdmLockFlags As System.Integer _
) 
C# 
void LockFile( 
   System.int lParentFolderID,
   System.int lParentWnd,
   System.int lEdmLockFlags
)
C++/CLI 
void LockFile( 
&   System.int lParentFolderID,
&   System.int lParentWnd,
&   System.int lEdmLockFlags
) 

Parameters

lParentFolderID
ID of parent folder to which to check out the file
lParentWnd
Parent window handle
lEdmLockFlags
Optional combination of EdmLockFlag bits; default is EdmLockFlag.EdmLock_Simple

Example

Remarks

When checking out several files, it is more efficient to use IEdmBatchGet than to repeatedly call this method to check out every file.

Return codes:

  • S_OK: The method successfully executed.
  • E_EDM_FILE_IS_LOCKED: The file is already checked out.
  • E_EDM_PERMISSION_DENIED: The user lacks permission to check out this file.
  • E_EDM_OPERATION_REFUSED_BY_PLUGIN: One of the installed EdmCmdType.EdmCmd_PreLock hooks did not permit the operation.
  • E_EDM_FILE_NOT_FOUND: The file was not found in the vault.
 

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:   LockFile 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.