IB_END

Define the end of a new input window

WTSupported in traditional Synergy on Windows
WNSupported in Synergy .NET on Windows
USupported on UNIX
VSupported on OpenVMS
xcall IB_END(build_id, window_id, [channel][, no_load])

Arguments

build_id

The ID of the input window under construction. (n)

window_id

Returned with the ID of the input window that is created. (n)

channel

(optional) The window library channel from which to load any pre‑built selection windows. (n)

no_load

(optional) Any non‑zero value. If passed, it will specify that the input window should not be loaded at this time. (n)

Discussion

IB_END ends an input window specification session. This subroutine is used when building a new input window at runtime.

Window_id is the identifier for the new input window. If window_id is returned zero, the input window building was unsuccessful.

After you call IB_END, no other IB_xxx subroutines can be used on this window (build_id). In fact, build_id should be discarded as it is no longer valid. However, you can still define other window features such as the border, display area, and text, just as you can with any input window.

After calling IB_END, you can place the window since you have the final ID (window_id).

If any of the fields in the input window use a prebuilt selection window (with the D_FLD_SELWND qualifier on IB_FIELD), and that selection window is not currently resident, channel is required in order to provide a window library channel from which to load the selection window, unless no_load is specified or the selection windows are already loaded.

No_load enables you to build an input window without using it right away. You can save it to a window library and load it later with I_LDINP. To do this, you must pass no_load, and then call U_SAVE for window_id. You will also need to specify the window name in the U_SAVE subroutine.

Examples

The following example ends the specification of an input window being built. The ID for the new input window is returned in wndid. Any associated selection windows will be loaded from the window library opened on g_utlib.

xcall ib_end(bldid, wndid, g_utlib)