ShowCheckInReminder Method

Description

Displays the checkin reminder for the specified object. Can fail if the object is open in another program.

Syntax

Visual Basic
Public Function ShowCheckInReminder( _ ByVal ParentWindow As Long, _ ByVal ObjVer As ObjVer, _ ByVal Asynchronous As Boolean _ ) As ObjectVersion

Visual Basic

Public Function ShowCheckInReminder( _
   ByVal ParentWindow As Long, _
   ByVal ObjVer As ObjVer, _
   ByVal Asynchronous As Boolean _
) As ObjectVersion

Parameters

ParentWindow
ObjVer: The object identifier for the object to be checked in.
Asynchronous: If this parameter is True, the call can return before the user reacts to the reminder prompt. In this case M-Files Client will invoke the reminder and no further interaction from M-Files API or the hosting application is required.

Remarks

Prompts the user to check in the document. If the user accepts the check in reminder, the object will be checked in.

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