basic.%fgets C Function/BASIC Program

basic.%fgets

Command basic.%fgets C Function/BASIC Program
Applicable release versions: AP/Unix
Category BASIC Program (486)
Description reads characters from the named input "stream" into "variable" until 'n'-1 characters are read or a new line character is read and transferred to the string.
The string is then terminated with a null character (hex '00'). A string of a size at least equal to 'n' must have been assigned to 'variable' before the call, otherwise the data is truncated. If less than n-1 bytes are returned, the content of the string beyond is undefined, as is usual in C. No data translation occurs.

The "pointer" returned has no meaning, except for a null value which indicates an error or that end of file has been encountered.
Syntax ptr=(char*)%fgets( variable, n, (char*)stream )
Options
Example
char line[128] ;* make a buffer 
pointer=(char*)%fgets( line, 128, (char*)stream )
if pointer#0 then
  line=field(line,char(0),1)
  print line
end
Purpose
Related basic.cfunc
basic.cfunction
basic.%fclose
basic.%fgetc
basic.%fopen
basic.%popen