Documentation

Delete

bool
CTasks::Delete(
  ID,
  array arParams = array()
);

This method deletes task with ID.

Note: This method accepts an array of configuration parameters and generates scripts, necessary to file dialog. Static method.

Method parameters

Parameter Description Available from version
ID Deleted task ID
arParams Array of additional parameters. Optional.

Returned value

This method returns true when the task is completed successfully, otherwise returns false. 

Examples of use

<?
if (CModule::IncludeModule("tasks"))
{

    $ID = 1;

    if($USER->IsAdmin())
    {
       CTasks::Delete($ID);
    }

}
?>


© «Bitrix24», 2001-2024
Up