spMFDeleteObject¶

Return

1 = Success object deleted
2 = Success object version destroyed
3 = Success object destroyed
4 = Failed to destroy
5 = Failed to delete
6 = Failed to remove version
-1 = SQL Error

Parameters

@ObjectTypeId int

OBJECT Type MFID from MFObjectType

@objectId int

Objid of record

@Output nvarchar(2000) (output)

Output message

@objectVersion int

the object version to be removed. default = -1 which indicates the delete the object rather than a version

@DeleteWithDestroy bit (optional)

Default = 0
1 = Destroy

@Update_ID Output

ID of the record in the MFUpdateHistory table

@ProcessBatch_ID Output

-ID of the record in the MFProcessBatch table

@Debug (optional)

Default = 0
1 = Standard Debug Mode

Purpose¶

An object can be deleted from M-Files using the ClassTable by using the spMFDeleteObject procedure. Is it optional to delete or destroy the object in M-Files.

The procedure can also be used to destroy a specific version of an object. This is particularly useful when old or outdataed versions must be removed from the system.

Additional Information¶

Use this procedure to delete or destroy a single object or object version. spMFDeleteObjectList can be used to delete a series of objects.

When DeleteWithDestroy = 1 the objectversion specified in ObjectVersion will be ignored and the ObjectVersion will automatically be set to -1. This will trigger the method to destroy the whole object. There is no need to manually set the ObjectVersion to -1. A status code 3 will be returned. When DeleteWithDestroy = 1 and the objectversion is set to 0 then the object will be destroyed. When DeleteWithDestroy = 1 and the object does not exist an error code of 4 will be returned

When DeleteWithDestroy = 0 and the ObjectVersion is set to 0 the whole object will be deleted. Status code 1 is returned. When DeleteWithDestroy = 0 and an ObjectVersion less that the latest object version is specified the ObjectVersion will be removed. A status code 2 is returned

When DeleteWithDestroy = 0 and an ObjectVersion that is equal to latest object version is specified the delete will fail with error 6 returned When DeletedWithDestroy = 0 and the object does not exist an error code 4 will be returned When DeletedWithDestroy = 0 and the object version does not exist, is not 0 and is not the latest version of the object then an error code 5 will be returned

Warnings¶

To delete an object the object version must be set to 0 and DeleteWithDestroy must be set to 0.

Note that when a object is deleted it will not show in M-Files but it will still show in the class table. However, in the class table the deleted column will have a date.

To delete a object version, the specified version must exist. Use spMFGetHistory to first pull all the versions of an object or objects, and then use the MFObjectChangeHistory table to determine the object versions to be removed.

Deleting and object version performs a destroy of the version. There is no possibility to undelete a deleted version.

The latest version of the object cannot be specified as the object version to be destroyed. When the latest version of the object is specified the object will be deleted.

Examples¶

Deleting and object¶

DECLARE @Output1 NVARCHAR(2000),
@update_ID INT ,
@ProcessBatch_ID1 INT,
@rt INT;

EXEC @rt = dbo.spMFDeleteObject @ObjectTypeId =136,
                     @objectId = 151,
                     @Output = @Output1 OUTPUT,
                     @ObjectVersion = 0,
                     @DeleteWithDestroy = 0,
                     @Update_ID = @Update_ID OUTPUT,
                     @ProcessBatch_ID = @ProcessBatch_ID1 OUTPUT,
                     @Debug = 0
SELECT @Output1
SELECT @rt, @update_ID, @ProcessBatch_ID1
SELECT * FROM dbo.MFUpdateHistory AS muh WHERE id = @update_ID
SELECT * FROM dbo.MFProcessBatch AS mpb WHERE mpb.ProcessBatch_ID = @ProcessBatch_ID1
SELECT * FROM dbo.MFProcessBatchDetail AS mpb WHERE mpb.ProcessBatch_ID = @ProcessBatch_ID1

Delete object versions¶

To delete an object version the objid and the version to delete is required. Use spMFGetHistory to get the valid versions of an object Then use spMFDeleteObject to destroy the specific version

UPDATE Mcoa
SET [mcoa].[Process_ID] = 5
FROM [dbo].[MFCustomer] AS [mcoa]
WHERE [mcoa].[ObjID] = 134
DECLARE @Update_ID INT
,@ProcessBatch_id INT;
EXEC [dbo].[spMFGetHistory] @MFTableName = 'MFCustomer'
                       ,@Process_id = 5
                       ,@ColumnNames = 'MF_Last_modified'
                       ,@IsFullHistory = 1
                       ,@NumberOFDays = null
                       ,@StartDate = null
                       ,@Update_ID = @Update_ID OUTPUT
                       ,@ProcessBatch_id = @ProcessBatch_id OUTPUT
                       ,@Debug = 0
SELECT * FROM [dbo].[MFObjectChangeHistory] AS [moch] WHERE [moch].[ObjID] = 134

Use a loop to destroy multiple versions of multiple objects

DECLARE @Output NVARCHAR(2000);
DECLARE @processBatch_ID INT;
DECLARE @Return_Value int

EXEC  @Return_Value = [dbo].[spMFDeleteObject] @ObjectTypeId = 136
                         ,@objectId = 134
                         ,@Output = @Output OUTPUT
                         ,@ObjectVersion = 9     -- set to specific version to destroy
                         ,@DeleteWithDestroy = 1 -- object version history is always destroy
                                                     ,@ProcessBatch_id = @processBatch_ID OUTPUT

SELECT @Return_Value

Changelog¶

Date	Author	Description
2022-06-23	LC	Set a default for @Update_ID parameter
2022-02-11	LC	Update audit history and class table with result
2022-02-11	LC	Align the error codes with the assemblies
2021-12-16	LC	Reset objectversion default to -1
2021-08-15	LC	Remove incorrect license check
2021-05-05	LC	Align single delete object without class table with wrapper
2020-12-08	LC	Change status messages and validate different methods
2020-04-28	LC	Update documentation for Object Versions
2019-08-30	JC	Added documentation
2019-08-20	LC	Expand routine to respond to output and remove object from change history
2019-08-13	DEV2	Added objversion to delete particular version.
2018-08-03	LC	Suppress SQL error when no object in MF found
2016-09-26	DEV2	Removed vault settings parameters
2016-08-22	LC	Update settings index
2016-08-14	LC	Add objid to output message