%U_ENUMWNDS

Return a list of windows in a library

WTSupported in traditional Synergy on Windows
WNSupported in Synergy .NET on Windows
USupported on UNIX
VSupported on OpenVMS
nmwnds = %U_ENUMWNDS(channel, [max][, array])

Return value

nmwnds

The number of windows in the window library specified by channel. (^VAL)

Arguments

channel

A window library channel. (n)

max

(optional) Maximum number of window names to return. (n)

array

(optional) The first element in an array for returned names. (a)

Discussion

%U_ENUMWNDS returns the number of windows in a window library and optionally returns the window names.

Channel must be an open file channel for a window library. If it isn’t open, Toolkit will generate a runtime error (“Channel has not been opened”), and if the file that channel is open on is not a window library, unpredictable behavior will result.

If max is less than the number returned in nmwnds, not all window names will be returned in array. If max is not passed or is less than 1, array is ignored.

If max is passed and is greater than zero, array must be the first element of an array (pseudo or real) of at least max elements.

If any read failure occurs (other than EOF), Toolkit generates a trappable runtime error.

Examples

The following example returns (in num_windows) the number of windows in the specified channel (chan), and it returns the names of the windows in names.

num_windows = %u_enumwnds(chn, max_names, names)