Guardian Procedure Calls Reference Manual

Parameters
filenum
input
INT:value
is a number that identifies the open file of interest. filenum was returned by FILE_OPEN_ or
OPEN when the file was originally opened.
You can also specify -1 for filenum to obtain the last-error value resulting from a file
operation that is not associated with a file number. See Considerations (page 427).
item-list
input
INT .EXT:ref.*
is an array of values that specify the items of information to be returned by the procedure. Each
element of the array is of type INT in TAL or pTAL, or type short in C/C++; it must contain
a code from Table 18.
number-of-items
input
INT:value
specifies the number of items supplied in item-list.
result
output
INT .EXT:ref:*
is the buffer in which the requested items of information are returned. It is an array of type INT
in TAL/pTAL or unsigned short/short in C/C++. The item values are returned in the
order specified in item-list. Each item begins on an INT, short, or unsigned short
boundary. Every variable-length item has an associated item giving its length; the caller should
put this associated item into item-list immediately before the variable length item. See
Considerations (page 427) for a discussion of buffer considerations for files that use increased
file limits.
result-max
input
INT:value
specifies the maximum size in bytes of the array of values that can be returned in result. If
the specified size is not large enough to hold the requested items, an error value of 563
(buffer too small) is returned.
result-length
output
INT .EXT:ref:1
returns the length in bytes of the array of values returned in result. result-length is an
odd value only if the last value in the array has an odd length.
error-item
output
INT .EXT:ref:1
returns the index of the item that was being processed when an error was detected. The index
of the first item in item-list is 0.
412 Guardian Procedure Calls (F)