21. 4GL Statement Glossary : Help_Field()
 
Share this page                  
Help_Field()
Provides help on a field or column through the Field menu item of the help_forms statement.
Syntax
returnfield = [callproc] help_field()
Description
When the 4GL help_forms statement is executed, the Field menu item on the resulting frame calls the built-in procedure help_field(). Help_field() provides access to FRS help for the current field or column.
If a validation is available for the current field or column, help_field() provides a description of the validation. If the validation is of the form "field in [list of values]", help_field displays a table field containing the list of values, and allows you to select one. If no validation is specified, help_field describes the data type and field format for the current field or column.
Help_field does not accept any parameters. This procedure returns an integer indicating whether a help value was selected. This is a positive integer if a value was selected from a list. Otherwise, it is 0.
Example
Call the built-in procedure help_field().
Intvar = callproc help_field();