OnRenameObjectFile Event

Description

Triggered when a object file is renamed. This event occurs before the request is passed for M-Files Server.

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

Parameters

objVer : IObjVer [ in ]

Identifies the target object version.

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

fileVer : IFileVer [ in ]

Identifies the file to rename.

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

newName : ITypedValue [ in, out ]

The new file name (file title), or null if the name (title) is not changed.

newExtension : ITypedValue [ in, out ]

The new file extension, or null if the extension is not changed.

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 object version updated in the operation.

objectFile : IObjectFile [ in ]

The updated object file.

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

Supported in M-Files 9.0.3372.6 and newer.