HTML_Progress_Monitor::setCaption

displays caption on action in progress

Synopsis

require_once 'HTML/Progress/monitor.php';

void HTML_Progress_Monitor::setCaption( string $caption = ' ' array $args = array())

Description

Allows to display a caption to action in progress into the dialog box monitor.

Parameter

string $caption: caption to action in progress

array $args: associative array of template variable, message text

Throws

Possible PEAR_Error values
Error level Error code Error message Solution

exception HTML_PROGRESS_ERROR_INVALID_INPUT invalid input, parameter #1 "$caption" was expecting "string" Fixed the cast of parameter

exception HTML_PROGRESS_ERROR_INVALID_INPUT invalid input, parameter #2 "$args" was expecting "array" Fixed the cast of parameter

Note

( HTML_Progress >= 1.1 )

This function can not be called statically.

Example

See example of HTML_Progress_Monitor::run.