| %FGETC | Index Level | %FOPEN |
| Syntax | ptr = (char*)%FGETS( variable, n, (char*)stream ) |
| Category | BASIC |
| Type | C Function |
| 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. |
| Options | |
| See Also | c function CFUNCTION %FCLOSE %FGETC %FOPEN %POPEN |
| 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 |
| Warnings | The NULL character may have to be removed explicitly, as in the example. |
| Compatibility | D3/Unix |
| %FGETC | Index Level | %FOPEN |