Click or drag to resize

Deleted Function (Usual)

X#
Return the deleted status of the current record.

Namespace:  XSharp.RT
Assembly:  XSharp.RT (in XSharp.RT.dll) Version: 2.19
Syntax
 FUNCTION Deleted(
	uArea AS USUAL
) AS LOGIC
Request Example View Source

Parameters

uArea
Type: Usual
Specifies the work area name or number for a table from which the value must be retrieved.

Return Value

Type: Logic
TRUE if the current record is marked for deletion; otherwise, FALSE.
If there is no database file in use in the work area, Deleted() returns FALSE.
Remarks
Deleted() determines if the current record in the active work area is marked for deletion. Since each work area with an open database file can have a current record, each work area has its own Deleted() value.
By default, this function operates on the currently selected work area.
It can be made to operate on an unselected work area by specifying it within an aliased expression or by calling the overload that accepts a workarea parameter (a workarea number or alias ).
In applications, Deleted() is generally used to query the deleted status as a part of record processing conditions, or to display the deleted status as a part of screens and reports.
Examples
This example uses Deleted() in the current and in an unselected work area:
X#
1USE customer NEW
2USE sales NEW
3QOut(Deleted())            // Result: FALSE
4Delete
5QOut(Deleted())            // Result: TRUE
6QOut(Customer->Deleted())    // Result: FALSE
See Also