Sub LockFile( _
   ByVal lParentFolderID As System.Integer, _
   ByVal lParentWnd As System.Integer, _
   Optional ByVal lEdmLockFlags As System.Integer _
) 

void LockFile( 
   System.int lParentFolderID,
   System.int lParentWnd,
   System.int lEdmLockFlags
)

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

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

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