OnCheckInObject Event

Description

Triggered when the check in of a vault object is requested. This event occurs before the request is passed for M-Files Server.

https://developer.m-files.com/APIs/COM-API/Reference/

Parameters

IObjVer [ in ]

Identifies the object version to check in.

propertyValues : IPropertyValues [ in, out ]

Specifies the property values to be applied with the check in operation.

Return Type

The return type can be one of the types as follows:

Object

Callback object to be activated after the operation. Callback methods:

OnSuccess Method [ optional ]

Called when the operation is successfully performed. The call receives parameters as follows:

objectVersion : IObjectVersion [ in ]

The updated object version.

OnError Method [ optional ]

Called when the operation failed. The call receives parameters as follows:

errorCode : Long [ in ]

The error code (HRESULT).

errorMessage : String [ in ]

The error message.

errorStack : String [ in ]

The call stack that identifies the error source in the program code.

Finally Method [ optional ]

Called after the operation was performed regardless of the operation success or failure.

Boolean

False to prevent the operation.

Null

Prevents the operation.

Remarks

The OnCheckInObjects Event is triggered, too.

Supported in M-Files 9.0.3372.6 and newer.