DBDelete
Use this procedure/function to delete all records which match the key criteria from the database table.
Syntax
DBDelete (Table, KeyName1, KeyValue1, KeyName2, KeyValue2,...)
|
Parameter |
Description |
|
Table |
Enter the name of an open table. |
|
KeyName, KeyValue, ... |
Each KeyName refers to the name of a column to search. For some database handlers, this may be a case-sensitive comparison. Each KeyValue is the value of the corresponding KeyName for which to search. For some database handlers, this may be a case-sensitive comparison. At least one KeyName/KeyValue pair are required. |
| Note | You will not be prompted for confirmation when deleting records. |
The system optionally returns one (1) on success or zero (0) on failure.
This procedure lets you enter as many KeyName and KeyValue combinations as necessary to identify the specific keyed record you want to delete.
This procedure first locates the records using the key you specify. If located, the records will be deleted. If the procedure returns failure, possible causes include:
- There are no records in the table meeting the given criterion
- The column specified in KeyName is not a searchable column
- Database-specific failure
Example
Here is an example:
|
Procedure |
Result |
Explanation |
|
DBDelete ( "APPIDX" , "Company" , "SAMPCO" , "Lob" , "Util") |
1 or 0 |
Assuming Company and Lob are valid key components for the APPIDX table, the procedure will delete all records with the value SAMPCO in the column named Company and the value Util in the column named Lob. |