L_RESTART

Restart a list

WTSupported in traditional Synergy on Windows
WNSupported in Synergy .NET on Windows
USupported on UNIX
VSupported on OpenVMS
xcall L_RESTART(list_id, [initial][, last])

Arguments

list_id

The ID of the list. (n)

initial

(optional) The number of the initial item to load. (n)

last

(optional) The estimated number of items that will be loaded. (n)

Discussion

L_RESTART “restarts” a list by erasing all existing items and setting up the list to start loading the first window of items. It also cancels any pending requests for L_PROCESS and for ActiveX controls, resets individual cell overrides for color and font.

The initial argument determines how list items are loaded into the list. If initial has a value of 1, existing items will only be loaded at the bottom of the list, forward. If initial is greater than 1 and equal to last, existing items will only be loaded at the top of the list, backward. If initial is greater than 1 but less than last, existing items can be loaded at either end, but loading will begin at the bottom, forward.

If initial is not passed, the item‑loading method defaults to the method that was specified on the previous call to L_CREATE or L_RESTART.

If last is not passed, or if it has a value of zero, the calling routine cannot determine the number of list items. Instead, Toolkit assumes last is greater than initial and determines this number internally.

No other features of the list are modified by L_RESTART; the title, headers, footers, enabled state, find specification, and definition of the initial state of an item all remain the same.

Examples

The following restarts the list whose ID is mylist. The item‑loading method will be the one used when the list was last restarted or created. The number of items to be loaded is unknown.

xcall l_restart(mylist)

The next example restarts the list whose ID is mylist. The items will be loaded in reverse order. The approximate number of items to be loaded is contained in nmitms.

xcall l_restart(mylist, nmitms, nmitms)