Guardian Procedure Calls Reference Manual

Returned Value
INT
A file-system error code that indicates the outcome of the call.
Item Codes
Table 18 shows the item codes used by FILE_GETINFOLIST_. Item codes of 30 and greater, except
item codes 201 through 206, are also used by FILE_GETINFOLISTBYNAME_.
NOTE: Items in this table with a size of 2 bytes are of data type INT. The term "disk file" applies
only to Enscribe files. The term "disk object" applies to Enscribe files and SQL objects.
Items described as "Applies only to SQL/MX objects" return file-system error 2 if queried on
anything that is not an SQL/MX object.
Table 18 FILE_GETINFOLIST_ Item Codes
DescriptionSize (Bytes)Item
Code
File-name length. The length in bytes of the file name returned by item 2.21
File name. The fully qualified name of the specified file at the time it was opened.*2
Current file name length. The length in bytes of the file name returned by item 4.23
Current file name. The current fully qualified name of the specified file. This might differ from
item 2 because the file might have been renamed since it was opened.
*4
DEFINE name length. For files opened with a DEFINE, the length in bytes of the DEFINE name;
for other files, 0.
25
DEFINE name. For files opened with a DEFINE, the name of the DEFINE.*6
Last error. The file-system error code resulting from the last file-system operation. If filenum
identifies an open file, the last error associated with that file number is returned. If filenum
27
is -1, the last error for an operation not associated with a file number is returned. See
Considerations (page 427).
Last-error detail. Additional information, if available, for interpreting the error reported by item
7. This value might be a file-system error code or another kind of value, depending on the
operation and the primary error.
28
Partition in error. For partitioned files, the number of the partition associated with the error
reported by item 7.
29
Key in error. For files with alternate keys, the specifier of the key associated with the error
reported by item 7.
210
Next record pointer. For disk files that are not key-sequenced and not accessed with alternate
key, the value of the next record pointer.
This item cannot be used with the 64-bit primary-key election of the FILE_OPEN_ procedure;
an attempt results in error 581. Superseded by item 201.
411
Current record pointer. For disk files that are not key-sequenced and not accessed with alternate
key, the value of the current record pointer.
This item cannot be used with the 64-bit primary-key election of the FILE_OPEN_ procedure;
an attempt results in error 581. Superseded by item 202.
412
Current key specifier. For structured disk files, the key specifier of the current key.213
Current key length. For structured disk files, the length in bytes of the current key value.214
This item cannot be used with the 64-bit primary-key election of the FILE_OPEN_ procedure;
an attempt results in error 581.
Superseded by item 203; see item 203 for detailed description.
FILE_GETINFOLIST_ Procedure 413