S_SELINF

Retrieve selection window information

WTSupported in traditional Synergy on Windows
WNSupported in Synergy .NET on Windows
USupported on UNIX
VSupported on OpenVMS
xcall S_SELINF(window_id, entry_number, entry_text, [fields][, numeric]) 

Arguments

window_id

The ID of the selection window. (n)

entry_number

The number of the selectable entry (supplied or returned). (n)

entry_text

The text of the selectable entry (supplied or returned). (a)

fields

(optional) Returned with the total number of selectable fields in the specified selection window. (n)

numeric

(optional) The true/false flag that specifies that entry_text is a numeric value. (n)

Discussion

S_SELINF returns information about a specified selection window.

If entry_number is non‑zero, S_SELINF retrieves the text for that entry and returns it in entry_text. If a matching entry is not found, entry_text returns a blank. Note that entry numbers don’t include text or line entries, only selectable entries. If entry_number is zero, S_SELINF searches for entry_text in the specified selection window. If found, the associated entry number is returned in entry_number. If not found, zero is returned. Note that the match is case sensitive and leading blanks are not ignored. However, if there is a leading blank created by S_SELBLD or the script compiler, it is ignored.

If the selection window entries are numeric, pass true for the numeric argument.

If you want to get information about or modify a selection window whose ID you don’t know, you can use the I_FLDINF subroutine to retrieve the ID of an attached selection window for a specified field.

Examples

With the following selection window, the first example returns “Bill” in text. The second example returns “4” in enum (provided that enum was zero upon entry) and “9” in numflds. (See S_SELBLD Examples for the code to create this selection window.)

Example selection window

xcall s_selinf(wndid, 4, text) 
xcall s_selinf(wndid, enum, "Bill", numflds)