Guardian Procedure Calls Reference Manual

FILE_GETINFO_ Procedure
Summary
Syntax for C Programmers
Syntax for TAL Programmers
Parameters
Returned Value
Considerations
OSS Considerations
Example
Related Programming Manuals
Summary
The FILE_GETINFO_ procedure obtains a limited set of information about a file identified by file
number.
A related procedure, FILE_GETINFOLIST_, obtains detailed information about a file identified by
file number.
Syntax for C Programmers
#include <cextdecs(FILE_GETINFO_)>
short FILE_GETINFO_ ( short filenum
,[ short *last-error ]
,[ char *filename ]
,[ short maxlen ]
,[ short *filename-length ]
,[ short *type-info ]
,[ short *flags ] );
• The parameter maxlen specifies the maximum length in bytes of the character string pointed
to by filename, the actual length of which is returned by filename-length. All three of
these parameters must either be supplied or be absent.
Syntax for TAL Programmers
error := FILE_GETINFO_ ( filenum ! i
,[ last-error ] ! o
,[ filename:maxlen ] ! o:i
,[ filename-length ] ! o
,[ type-info ] ! o
,[ flags ] ); ! o
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 406).
404 Guardian Procedure Calls (F)