High-Level Screen Management Intrinsic Library Reference Manual (32424-90002)

3- 11
positive, the number is the one assigned the
component by the design facility. If the value
is negative, the number indicates the order of
the component within the design.
infobuflen A four-byte integer that tells the intrinsic
the length in bytes of the infobuf parameter.
infobuf The area into which the information you have
requested is returned from the intrinsic. The
format of the information returned is specific
to the type of design component you requested:
file, form, or field. Format is also
determined by the design facility that was used
to create the forms. See Table 3-2 for
complete information about how information and
formats are returned from the intrinsic. The
amount of information returned is determined by
either the applicable format or the contents of
infobuflen , whichever is less.
Discussion
HPDGETDESIGN is a special-purpose intrinsic that lets you extract design
information about a FORMSPEC/V forms file. Use this intrinsic to
document forms files or to generate source code data structures such as
copylibs.
Because HPDGETDESIGN is a special-purpose intrinsic, you must allocate a
separate copy of the
globalpak parameter to pass to the intrinsic. You
cannot pass this copy of
globalpak to any of the other Hi-Li intrinsics.
For efficiency, the intrinsic opens the forms file for you. If you want
to close the file, use a negative number for the value of the mode
parameter.
The
keydescrpt parameter tells HPDGETDESIGN the format, number or name
of the retrieval key. For example, if you are retrieving information
about a field, you might set up the
keydescrpt array in your application
as follows:
* Assign 1 to the first integer in the array to indicate the first key
(file) is in name format.
* Assign 0 to the second integer in the array to indicate the second
key (form) is in number format.
* Assign 1 to the third integer in the array to indicate the third key
(field) is in name format.
Table 3-2 lists the infobuf subparameters and shows how information and
formats of FORMSPEC/V forms files are returned from the intrinsic. The
value of
mode is treated as an absolute number.