fread_lineT_fread_lineFreadLineFreadLine (Operator)

Name

fread_lineT_fread_lineFreadLineFreadLine — Read a line from a file.

Signature

fread_line( : : FileHandle : OutLine, IsEOF)

The operator fread_linefread_lineFreadLineFreadLineFreadLine reads a line from the current input file (including the line skip) defined by the handle FileHandleFileHandleFileHandleFileHandlefileHandle. The input file must be opened in ASCII format. The read line is returned in parameter OutLineOutLineOutLineOutLineoutLine. If the end of the file is reached, IsEOFIsEOFIsEOFIsEOFisEOF returns the value 1, otherwise 0.

Execution Information

Multithreading type: reentrant (runs in parallel with non-exclusive operators).
Multithreading scope: global (may be called from any thread).
Processed without parallelization.

Parameters

FileHandleFileHandleFileHandleFileHandlefileHandle (input_control) file → (handle)

File handle.

OutLineOutLineOutLineOutLineoutLine (output_control) string → (string)

Read line.

IsEOFIsEOFIsEOFIsEOFisEOF (output_control) integer → (integer)

Reached end of file.

Example (C)

do {
  fread_line(FileHandle,&Line,&IsEOF) ;
} while(IsEOF==0) ;

Result

If the file is open and a suitable line is read, fread_linefread_lineFreadLineFreadLineFreadLine returns the value 2 (H_MSG_TRUE). Otherwise, an exception is raised.