ShowCheckoutPrompt Method

Description

Displays the object checkout prompt for the user.

Syntax

Visual Basic
Public Function ShowCheckoutPrompt( _ ByVal ParentWindow As Long, _ ByVal Message As String, _ ByVal ObjID As ObjID, _ ByVal ShowCancel As Boolean, _ Optional ByVal AutoRejectConsequentPrompts As Boolean = False _ ) As ObjectVersion

Visual Basic

Public Function ShowCheckoutPrompt( _
   ByVal ParentWindow As Long, _
   ByVal Message As String, _
   ByVal ObjID As ObjID, _
   ByVal ShowCancel As Boolean, _
   Optional ByVal AutoRejectConsequentPrompts As Boolean = False _
) As ObjectVersion

Parameters

ParentWindow
Message: The message to be shown in the checkout prompt.
ObjID: The object identifier for the object to be checked out.
ShowCancel: If this parameter is True, the cancel button is shown.
AutoRejectConsequentPrompts: If true, the object checkout prompt can be rejected automatically without showing the dialog box if the checkout was rejected recently in another application.

Return Type

The object version data for the object. If the checkout prompt was cancelled, an empty (null or equivalent) reference is returned.

Remarks

This method displays a checkout prompt for the user. If the user accepts the check out, the object will be checked out. Use the returned object version data to resolve whether the object was checked out.

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