ph_msgbox PowerHome formula function
Description
Displays a message box window.
Syntax
ph_msgbox ( title, message, timeout )
| Argument |
Description |
|
title |
String. The title to display within the title bar of the window. |
|
message |
String. The text to display within the body of the window. |
|
timeout |
Integer. The number of seconds for the window to display before automatically closing itself. Use 0 for the window to not close itself automatically. |
Return value
Integer. Returns a 0.
Usage
Use this function to quickly display a message to the user. It is important to note that this function DOES not wait for the user to press a button or the window to timeout. PowerHome execution WILL NOT be halted and will continue as normal. There is NO way to detect if the user has closed the window or if the window has timed out short of programatically looping and checking for the existance of the window. This function is intended ONLY for the display of informational text. If you wish to display messages and continue processing after the user has closed the message box, use the macro command "Message Box".
Examples
The following examples demonstrate typical syntax/usage for this function.
• ph_msgbox("SYNC-GRAPHIC1","DVC ID=[LOCAL1]; CC BUT ID=[LOCAL2]~r~n Intensity=[LOCAL3]",10)
• ph_msgbox("","LOCAL5=[LOCAL5]",10)
• ph_msgbox("INITIALIZE","Initialization Finished",3)
• ph_msgbox("SYNC-GRAPHIC4","[LOCAL1] ON and CC item made yellow",5)