TASK_DELETE ()

TASK_DELETE(task_reference)

API Version	2.8.1 and higher

Deletes a TASK

The action executed by this FORMULA depends on the type of TASK and its current status:

The TASK must be in the current ADMISSION.
If task_reference refers to a TASK that is closed, this function will do nothing. Closed TASKS can’t be deleted.

Input Parameters

Parameter

Type

Default

Description

task_reference

Reference to a TASK OBJECT. Accepted values:

Numeric value: it is considered to be a direct TASK reference.
Alphanumeric string: it is considered a TASK_CODE. Note that referring to a TASK by its TASK_CODE can result in multiple TASKS deleted.
A formula expression that returns valid TASK reference

The TASK reference or TASK_CODE is searched only in the current ADMISSION (the one where the formula is executed).

Return value

This function does not return a value

Execution

On closing the form. The ITEM containing this FORMULA must be defined as type 'ACTION' (which are always executed when a FORM is closed)

Examples

Formula	Description

Formula	Description
`TASK_DELETE(12322)`	Deletes the TASK with reference 12322
`TASK_DELETE("MANEUVER:BAS")`	Deletes all open TASKs of the current ADMISSION whose TASK_CODE is "MANEUVER:BAS"
`TASK_CANCEL(ADMISSION.TASK{MANEUVER:BAS}.REF, 0)`	Deletes all open TASKs in the current ADMISSION whose TASK_CODE is "MANEUVER:BAS" (see OBJECT CODES)