U_POPUP

Pop up a window

WTSupported in traditional Synergy on Windows
WNSupported in Synergy .NET on Windows
USupported on UNIX
VSupported on OpenVMS
xcall U_POPUP([channel], window_name, [search], [D_BELL|D_NOBELL], 
&     [D_ALERT|D_ERROR], [error][, D_HELP])

Arguments

channel

(optional) The window library channel. (n)

window_name

The name of the window to load. (a)

search

(optional) The search variable. (n)

D_BELL | NOBELL

(optional) Ring the terminal bell (default) or don’t ring the terminal bell. (n)

D_ALERT | D_ERROR

(optional) Do alert processing (default) or do error processing. (n)

error

(optional) Returned with the error value. (n)

D_HELP

(optional) Use help window renditions. (n)

Discussion

U_POPUP pops up a window. On Windows, U_POPUP creates a Windows‑style message box with an “OK” button.

U_POPUP calls U_LDWND to load the window from the specified library. If channel is not passed, g_utlib will be used.

If search is present, U_POPUP will search for an existing window with the specified name before trying to load it from the library. If it isn’t already loaded and it isn’t in the library, a fatal Toolkit error occurs.

The D_ALERT and D_ERROR arguments are passed to the U_WAIT subroutine to wait for a user response. If neither is specified, U_POPUP assumes an alert state. The terminal bell (and MessageBeep on Windows) will not ring if g_beep is set to false (see g_beep).

If D_HELP is present, the renditions of window_name will be set to the help window renditions.

If the window was loaded by U_POPUP, it will be deleted before the subroutine returns. A “Window not found” error occurs if the specified window cannot be found.

See also

U_WAIT routine for more information on the wait flags

Examples

This example pops up the window named “custhlp,” located in the window library on the channel stored in chnl. U_POPUP assumes an error‑style waiting state and displays the window with help window renditions.

xcall u_popup(chnl, "custhlp",,, D_ERROR,, D_HELP)