DELETE Function (Record)

Deletes a record in a Dynamics NAV table.

Syntax


[Ok :=] Record.DELETE([RunTrigger])  

Parameters

Record
Type: Record

The record to be deleted. The record itself does not change.

Note

The record cannot be from table 2000000001, the Object table or table 2000000006, the Company table.

RunTrigger
Type: Boolean

Specifies whether to run the C/AL code in the OnDelete Trigger.

If this parameter is true, then the code in the OnDelete trigger is executed. If this parameter is false, then the code in the OnDelete trigger is not executed.

The default value is false.

This parameter is optional.

Property Value/Return Value

Type: Boolean

true if the record was deleted; otherwise false. If the C/AL code terminates, then false is returned.

If you omit this optional return value and if the record is not deleted, then a run-time error occurs. If you include the return value, then you must handle any errors.

Remarks

The current key and any filters on the record do not affect this operation. The record to delete is identified by the values in its primary key.

If an end-user modifies a record between the time that another end-user or another process reads the record and modifies it, then the second user must refresh the value of the record variable before editing the record. Otherwise, the end-user receives the following run-time error:

Another user has modified the record for this <Table Name> after you retrieved it from the database.

Enter your changes again in the updated window, or start the interrupted activity again.

In earlier versions of Dynamics NAV, certain situations allowed code that an end-user runs to modify a record after a newer version of the record was written and committed to the database. This would overwrite the newer changes. However, in Microsoft Dynamics NAV 2018, we have restricted the MODIFY Function (Record), RENAME Function (Record), and DELETE Function (Record) so that the end-user receives the following run-time error in these certain situations:

Unable to change an earlier version of the <Table Name> record. The record should be read from the database again. This is a programming error.

You must design your application so that you use the most up-to-date version of the record for modifications to the database. You use the GET Function (Record) to refresh the record with the latest version. The second example illustrates this situation.

Example

The first two lines of code in this example do not use the return value from the DELETE function. This means that a run-time error occurs if the record to be deleted cannot be found.

The next lines of code show how you can handle errors using the return value.

This example requires that you create the following variables and text constants in the C/AL Globals window.

Variable name DataType Subtype
CustomerRec Record Customer
Text constant name ConstValue
Text000 The customer has been deleted.
Text001 The customer could not be found.
// Without using the return value:  
CustomerRec."No." := '100';  
CustomerRec.DELETE;  
// Using the return value:  
CustomerRec."No." := '100';  
IF CustomerRec.DELETE THEN  
  MESSAGE(Text000)  
ELSE  
  ERROR(Text001);  

Example

This example shows that you get an error if you attempt to delete a record after a newer version of the record has been written and committed to the database. This example requires that you create the following variables in the C/AL Globals window.

Variable name DataType Subtype
CustomerRec1 Record Customer
CustomerRec2 Record Customer

In this example, you get a copy of a record from the Customer table and put it into the CustomerRec1 variable, then you modify the record. Next, you get a copy of the same record from the Customer table and put it into the CustomerRec2 variable. You modify the record and commit the changes to the database. Now the CustomerRec1 variable is out-of-date with the value in the database. If you were allowed to modify the database using the CustomerRec1 record, then the changes that you made with CustomerRec2 would be overwritten by the values in the CustomerRec1 variable. Microsoft Dynamics NAV 2018 does not allow you to delete a record using an old version of the record.

Note

If you do not call the COMMIT function in this example, then you do not receive an error.

CustomerRec1.LOCKTABLE;  
CustomerRec1.GET('10000');  
CustomerRec1."Address 2" := 'Suite 101';  
CustomerRec1.MODIFY;  

CustomerRec2.GET('10000');  
CustomerRec2."Phone No.":= '206-555-0109';  
CustomerRec2.MODIFY;  

COMMIT;  

CustomerRec1.DELETE;  

If you run this code example, then you get the following error:

Unable to change an earlier version of the Customer record. The record should be read from the database again. This is a programming error.

Identification fields and values:

No.='10000'

See Also

Record Data Type
DELETEALL Function (Record)
DELETE Function (RecordRef)
COMMIT Function (Database)
LOCKTABLE Function (Record)