ProposeCheckOutForFile Method

Description

Proposes checkout operation for the object file. System may prompt for checkout. Returns error on cancel.

Syntax

Visual Basic
Public Function ProposeCheckOutForFile( _ ByVal ParentWindow As Long, _ ByVal ObjVersionFile As ObjectVersionFile, _ ByVal CanCancel As Boolean _ ) As Boolean

Visual Basic

Public Function ProposeCheckOutForFile( _
   ByVal ParentWindow As Long, _
   ByVal ObjVersionFile As ObjectVersionFile, _
   ByVal CanCancel As Boolean _
) As Boolean

Parameters

ParentWindow
ObjVersionFile: The file identifier for the file to be checked out.
CanCancel: If this parameter is True, the user is allowed to cancel the check out operation.

Return Type

Returns True if the user chose to check out the file, False otherwise.

Remarks

This method does not actually check out the file but simply shows the UI dialog asking the user. The API caller can then check the return value and continue with appropriate actions.

This method is available only if M-Files API is used in the client interface mode.