Develop > Programming > System Language reference > List: rtecalls > rtecall("statusupdate") function

rtecall("statusupdate") function

A RAD function that dynamically changes the caption of a widget on the current format. The widget must have a name property specified. This function is commonly used to update the format during a long-running transaction to inform the user of the status of the current operation. For example, converting a file to an RDBMS.

Function

rtecall("statusupdate")

Format

$L.success.flag = rtecall($L.func.name, $L.return.code, $L.widget.name, $L.widget.caption

Parameters

The following parameters are valid for the rtecall("statusupdate") function:

Parameter Data type Description
$L.widget.name String The name of the form widget, as specified in the name property of the widget.
$L.widget.caption String A string to be displayed in the widget.

Factors

If the $L.success.flg is false, the function failed. If it is true, the function succeeded.

Example

L.success.flg - rtecall("statusupdate", $L.return, "MyScrollingMarqueeWidget", "The end user will see this text in the marquee" )