Inquire_forms
Provides runtime information concerning the FRS.
Syntax
inquire_forms objecttype {parentname}
(fieldname = inquire_forms_constant [(objectname)]
{, fieldname = inquire_forms_constant
[(objectname)]})
objecttype
Specifies the name of the form or field for which information is being obtained:
frs
Indicates FRS itself
form
Indicates a form
field
Indicates a simple field
row
Indicates a row in a table field
column
Indicates a column in a table field
menu
Indicates a menuitem on the form
table
Indicates a table field
The objecttype is a 4GL name and must be a character string.
parentname
Specifies the form in which a simple field or menu under inquiry resides or the form and table field in which a column or row under inquiry resides. This is a 4GL name and must be expressed as a character string.
A null string (' ') or a blank string indicates the current parent (that is, the form belonging to the current frame, or the table field on which the cursor currently rests). The parentname is not used when the objecttype for the statement is frs or form.
fieldname
Specifies the name of the field (with an appropriate data type) to hold the value of the inquire_forms_constant.
inquire_forms_constant
Specifies a keyword that identifies the information to be obtained from FRS. Also referred to as an FRS constant.
objectname
Specifies the name of the form or field for which a value is sought. This is a 4GL name and must be expressed as a character string. If omitted, the default is the current object. All forms or fields in the statement must have the same parent.
Description
The 4GL inquire_forms statement lets you retrieve information at run time from the FRS. The FRS manages many aspects of the forms that are displayed as an application runs. Typically, you use inquire_forms to retrieve information about your current form. You can only inquire on forms that have been displayed in the window during the current execution of the application.
If the application uses a submenu, you must place the inquire_forms statement prior to the submenu. If you inquire afterward, the value Undefined is returned. However, if your request applies to the submenu itself, place the inquire_forms statement within the submenu.
For forms, fields, and the FRS, Ingres provides a set of constants containing information that the application can use to perform conditional processing, position pop-up forms, handle errors, and so on. The inquire_forms statement returns a different set of constants for each form or table field for which information is requested. In addition to the general syntax shown above, the following sections cover the specific syntax and a list of constants for each type.
The set_forms statement sets the value of the constants, which you retrieve with inquire_forms. Most inquire_forms statements have corresponding set_forms statements. See
Set_forms for more information.
The discussion below is divided into two main sections, Inquire_forms formobject and Inquire_forms FRS, on the basis of objecttype.
• Inquire_forms formobject covers statements, which take one of these objecttypes: column, field, form, row, table or menu. The statements are presented in alphabetical order by objecttype.
• Inquire_forms FRS covers variations of the inquire_forms frs statement. The statements are presented in alphabetical order by inquire_forms_constant.
Last modified date: 08/28/2024