4. System Classes : QueryObject Class : DBDelete Method
 
Share this page                  
DBDelete Method
The DBDelete method deletes rows from database tables when the rows contain columns for which the IsDeleteWhere attribute has been set to TRUE.
This method has the following syntax:
integer = QueryObject.DBDelete([rownumber = integer]
          [, isrepeated = integer]
          [, zerorowsiserror = integer][, maxrows = integer])
This method has the following parameters:
rownumber
Specifies the row in the cache. This parameter is needed only if the query is opened in QY_CACHE mode. This parameter defaults to the current row.
isrepeated
Specifies whether the query is repeated. Valid values are TRUE and FALSE.
Default: FALSE
zerorowsiserror
Specifies whether an error is generated for zero rows to be deleted. Valid values are TRUE or FALSE.
Default: FALSE
maxrows
Specifies the maximum number of rows that can be removed before generating an error. If this parameter is greater than zero, it specifies that removal of more than this number of rows is an error.
Default: 0
If the DBDelete method is successful, it returns ER_OK. If it is not successful, it returns a non-zero value. Descriptions of system constant values and their numeric equivalents are listed in Error Codes (see Error Codes).