WINMESSAGE
Usage
TIBCO iProcess Workspace (Windows)
Warning: (iProcess only) This expression is not available to the TIBCO iProcess Script Server Plug-in. Therefore, even though you can successfully enter the expression in your iProcess Script plug-in definition, it will not be processed by the iProcess Engine. It will return SW_NA.
Display a message in a small window. The window appears above all others and the text is shown in up to 3 lines of about 40 characters each; the message is word-wrapped, or you may force a new line with a \n sequence (see the following example).
Syntax
WINMESSAGE (mesg, x, y)
where:
| • | mesg is a text string specifying the message to display in the window. The window is created if it does not exist; otherwise the existing one is used. A call to the function with the null string "" as a message closes the window. |
| • | x is one of the following numeric values, specifying the horizontal position of the window on the screen: |
|
Value |
Window’s horizontal position |
|
0 |
Left side |
|
1 |
Center |
|
2 |
Right side |
| • | y is one of the following numeric values, specifying the vertical position of the window on the screen: |
|
Value |
Window’s vertical position |
|
0 |
Top |
|
1 |
Center |
|
2 |
Bottom |
Returns
One of the following Boolean values:
|
Value |
Description |
|
TRUE |
Success |
|
FALSE |
Failure |
Example
TIBCO iProcess Modeler:
In a script:
WINMESSAGE("Scanning\nPlease wait", 1, 1)
; Show message (on two lines) in a window
; in the center of the screen during
; iProcess function calls.
WINMESSAGE ("", 0, 0) ; remove message box
TIBCO Business Studio:
IPEEnvironmentUtil.WINMESSAGE("Scanning\nPlease wait", 1, 1);
/* Show message (on two lines) in a window
* in the center of the screen during
* iProcess function calls. */
IPEEnvironmentUtil.WINMESSAGE("", 0, 0); // remove message box