Name

Pkg::CallbackProgressReportStart — Register a callback function

Synopsis

void CallbackProgressReportStart ( string args );
 

Parameters

string args

Name of the callback handler function. Required callback prototype is void(integer id, string task, boolean in_percent, boolean is_alive, integer min, integer max, integer val_raw, integer val_percent). Parameter id is used for callback identification in the Progress() and in the End() callbacks, task describe the action. Parameter in_percent defines whether the progress will be reported in percent, if is_alive is true then the progress will be 'still alive' tick, if both in_percent and is_alive are then a raw value is reported (e.g. number of processed files without knowing the total number).

The callback function is evaluated when an progress event starts

Return

void