<< Click to Display Table of Contents >> Navigation: Robo-FTP User's Guide > Script Programming > Script Commands > All Script Commands > DASHBOARDMSG Command used to update Robo-FTP Dashboard |
Syntax: |
DASHBOARDMSG |
[ message ] [ /options ] |
Arguments: |
[ message ] |
A variable or string containing the message to write to the “Messages” column of Robo-FTP Dashboard. |
Options: |
/status=good |
This option will set the color under the “Status” column to green. |
|
/status=warn |
This option will set the color under the “Status” column to yellow. |
|
/status=bad |
This option will set the color under the “Status” column to red. |
The DASHBOARDMSG script command is used to update the Robo-FTP Dashboard.
If the /status option is omitted the color under the Dashboard's “Status” column will not change; it will remain the same.
The following example will change the message under the “Messages” column to “Running Script” but does not change the status color.
DASHBOARDMSG "Running Script"
The following example will change the message under the “Messages” column to “Error occurred logging onto FTP site” and it will also change the color in the “Status” column to red.
DASHBOARDMSG "Error occurred logging onto FTP site" /status=bad
PAUSE /for=2
GOTO send_err_email
Depending on the speed of your computer and the particular commands in your script, script execution may proceed faster than the Messages column can update. Consider inserting a short PAUSE after a call to DASHBOARDMSG if updating the Message column text is very important to your process.
Related command(s): DISPLAY, CONSOLEMSG, LOGMSG, LOGNTEVENT, MESSAGEBOX, PRINT, WRITEFILE
See also: Robo-FTP Dashboard