Use this function to retrieve the description specified in the FORM.DAT file for a specific form.
FormDesc (Count, StartForm, Group)
|
Parameter |
Description |
|
Count |
An index reference to locate a form before or after the specified form. To move backwards, enter a negative number. The default is zero (0). |
|
StartForm |
Enter the name of a form from which to start the search. The default is the current form. |
|
Group |
Enter the name of a group which contains the form you specified. The default is the current group. |
The system lets you get the description specified in the FORM.DAT file for the specified form, relative to a known form. If you omit all parameters, the system returns the description of the current form.
The Count parameter tells the system to move a number of forms forwards or backwards from the specified form before it returns the form description.
If the system cannot locate the starting form or the Count parameter tells the system to move beyond the number of forms contained in the group, the system returns an empty string.
Here are some examples:
Assume there are three forms: FORMA, FORMB, and FORMC. Also assume the current form is FORMB and its description is Fire Form # 2345.
|
Function |
Result |
Explanation |
|
FormDesc( ) |
Fire Form # 2345 |
No parameters will result in returning the current form description. |
|
FormDesc ( 2, "FormC") |
Empty string |
Returns an empty string if the form cannot be located. |
|
FormDesc ( -1, "FormC") |
Fire Form # 2345 |
Locates FORMC in the current group. Then returns the description of the form that occurs before this form. |
© Copyright 2017, Oracle and/or its affiliates. All rights reserved. Legal Notices