Language Reference Guide : System Classes : ArrayObject Class : SetRowDeleted Method
 
Share this page          
SetRowDeleted Method
The SetRowDeleted method sets the _RowState attribute for the row to RS_DELETED and assigns the row a nonpositive sequence number in the array. If the array is displayed in a table field, it removes the row from the display.
This method has the following syntax:
integer = ArrayObject.SetRowDeleted(rownumber = integer)
This method has the following parameter:
rownumber
Specifies a value that can be any sequence number in the array
After the SetRowDeleted method is executed, the row number used as a parameter no longer represents the deleted row, because that row has been moved. All rows that had a higher sequence number are shifted down. For example, if you specified row 10 in the SetRowDeleted method, row 11 becomes row 10 and the previous row 10 is assigned a nonpositive value.
SetRowDeleted returns ER_OK if it is successful, or ER_ROWNOTFOUND if the specified row does not exist. Descriptions of system constant values and their numeric equivalents are listed in Error Codes.
For a discussion of using this method, see the Programming Guide.