U_FLASH

Flash a message window

WTSupported in traditional Synergy on Windows
WNSupported in Synergy .NET on Windows
USupported on UNIX
VSupported on OpenVMS
xcall U_FLASH([channel], window_name, [window_id][, flag])

Arguments

channel

(optional) The channel of the window library containing the window to flash. (n)

window_name

The name of the window to load from the window library. (a)

window_id

(optional) Returned with the window ID. (n)

flag

(optional) A flag returned non‑zero if the specified window is not found. (n)

Discussion

U_FLASH flashes a message window on the screen.

The window will be loaded (if it’s not already) and placed. The current message window renditions will be applied to the window. The screen will be updated in order to make the window visible. The window will then be removed upon the next screen update.

The window will be deleted when the current environment is exited, or it may be explicitly deleted with the U_WINDOW subroutine.

This subroutine is ideal for handling “Please wait” type messages because any input or other visible change to the screen will remove the message. However, if window_id is passed, the calling routine can place or remove the window at will after this subroutine is called.

If channel is not passed, g_utlib will be used.

Examples

This example will try to load the window named “wait” from the window library opened on g_utlib. If the window is found, nofind will be returned as zero, the window_id will be returned in wndid, and the window will be displayed on the screen until the next screen update occurs.

xcall u_flash(g_utlib, "wait", wndid, nofind)