I_DISPLAY

Display data to input fields

WTSupported in traditional Synergy on Windows
WNSupported in Synergy .NET on Windows
USupported on UNIX
VSupported on OpenVMS
xcall I_DISPLAY(window_id, [set_name], data_area, [field_list1], [field_list2], 
&     [field_list3], [field_list4], [field_list5], [field_list6], [field_list7], [field_list8],
&      [field_list9][, a_methoddata1, …, a_methoddata20])

Arguments

window_id

The ID of the input window containing the fields to be displayed. (n)

set_name

(optional) The name of the input set associated with the fields. (a)

data_area

The data area for the structure associated with the input set that contains the data to display. (a)

field_list1 through field_list9

(optional) Up to nine field specifications, or *ENABLED* to display enabled fields only. (a)

a_methoddata1 through a_methoddata20

(optional) Up to 20 additional data arguments. (any)

Discussion

I_DISPLAY loads data in input fields according to the structure associated with the input set. For example, suppose you want to display some support information such as item name, sales amount, or delivery date while a transaction is being input. You can create an input field for each of the information displays (defining their data types and display formats) and then place these fields in their own input set. If you set breaks in the transaction input set at appropriate input fields, you can use I_DISPLAY to perform your information displays. (An additional benefit of this method is that it also places the controls for the information displays, along with the input fields, outside of the programs.)

If set_name is not present, I_DISPLAY defaults to the first input set.

I_DISPLAY loads data from data_area to the corresponding field(s) in the window and marks the field(s) “not empty.” Note that by default, Toolkit does not ensure that data_area is large enough for the fields it references. Toolkit generates an error for this condition only if g_dtkbounds is set to 1 or greater. See g_dtkbounds.

The fields referenced by this subroutine must be part of an input set for the window.

You can specify up to nine field lists (field_list arguments), each of which can have from one to nine field specifications. If a field_list has multiple field specifications, separate the field specifications with any character except alpha characters, numeric characters, dollar sign ($), underscore (_), and square brackets ( [ or ] , which are used to enclose dimension specifications for repository arrayed fields). For example:

"name"

or

"name, birthday, soc_sec_no, employer, phone, policy_no, conditions[2]"

The maximum length of a field_list is 99 characters. Additional characters are ignored. For information on field specifications, see Field specifications.

If you don’t specify any fields, all fields within the set will be displayed.

A_methoddata1 through a_methoddata20 are up to 20 additional optional arguments that can be passed to I_DISPLAY. I_ DISPLAY, in turn, passes them directly to %IDISPLAY_METHOD. This allows you to communicate additional information to your display method. Be careful to specify method data arguments only after you have passed all the field lists, so that a_methoddata1 is the 13th argument passed, with any subsequent method data arguments following.

Note that if I_DISPLAY is used with an unframed field after the input window for the field has been added to a tab set, renditions will be applied to the field that may not match the renditions for the window. See %TS_TABSET for more information.

See also

Examples

The following example loads all input fields in input set maindcs with data from the dcsmast data area.

xcall i_display(dcswnd, "maindcs", dcsmast)

The next example loads the input fields name, addr[2], city, st, and zip using the data in the cusmas data area, and these fields reside in the cusmas input set.

xcall i_display(inpid, "cusmas", cusmas, "name, addr[2], city, st, zip")

The following example displays only the enabled fields in the input set inpset, and does not alter disabled fields. It passes method_data as the method data argument.

xcall i_display(inpid, "inpset", record, "*ENABLED*",,,,,,,,, method_data)