Triggered when the object is marked as favorite object. This event occurs before the request is passed for M-Files Server.

objID : IObjID [ in ]

Identifies the operation target object.

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.

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.

The OnAddObjectsToFavorites Event is triggered, too.

Supported in M-Files 9.0.3372.6 and newer.