NAG Library Function Document

nag_read_line (x04bbc)

1  Purpose

2  Specification

3  Description

4  References

5  Arguments

1:    $\mathbf{fileid}$ – Nag_FileIDInput

On entry: the identifier of the file to be read from. This must have been returned by a call of nag_open_file (x04acc).

2:    $\mathbf{line}$ – char *Output

A character buffer of length linelen.

On exit: contains a null-terminated character-string read from the file associated with the FileID. If line is too small to hold the entire string, excess characters are discarded.

3:    $\mathbf{linelen}$ – IntegerInput

On entry: the size of the character buffer line. If $\mathbf{linelen}\le 0$, no characters are read and line is unchanged.

4:    $\mathbf{fail}$ – NagError *Input/Output

The NAG error argument (see Section 3.6 in the Essential Introduction).

6  Error Indicators and Warnings

NE_READ_ERROR

Error occurred when reading from FileID $〈\mathit{\text{value}}〉$.

7  Accuracy

8  Parallelism and Performance

9  Further Comments

10  Example