NAG FL Interface
x04bbf (line_​read)

1 Purpose

2 Specification

3 Description

4 References

5 Arguments

1: $\mathbf{nin}$ – Integer Input

On entry: the Fortran unit number which identifies the file to be read from. If $\mathbf{nin}<0$ (not a valid Fortran unit number), then no input occurs.

2: $\mathbf{recin}$ – Character(*) Output

On exit: the first $\mathrm{len}\left(\mathbf{recin}\right)$ characters of the record read from unit nin, padded with trailing blanks if the record was shorter than $\mathrm{len}\left(\mathbf{recin}\right)$.

3: $\mathbf{ifail}$ – Integer Input/Output

On entry: ifail must be set to $0$, $-1$ or $1$ to set behaviour on detection of an error; these values have no effect when no error is detected.

A value of $0$ causes the printing of an error message and program execution will be halted; otherwise program execution continues. A value of $-1$ means that an error message is printed while a value of $1$ means that it is not.

If halting is not appropriate, the value $-1$ or $1$ is recommended. If message printing is undesirable, then the value $1$ is recommended. Otherwise, the value $0$ is recommended. When the value $-\mathbf{1}$ or $\mathbf{1}$ is used it is essential to test the value of ifail on exit.

On exit: $\mathbf{ifail}=\mathbf{0}$ unless the routine detects an error or a warning has been flagged (see Section 6).

6 Error Indicators and Warnings

$\mathbf{ifail}=1$

End-of-file or reading error detected in a READ statement.

$\mathbf{ifail}=-99$

An unexpected error has been triggered by this routine. Please contact NAG.

See Section 7 in the Introduction to the NAG Library FL Interface for further information.

$\mathbf{ifail}=-399$

Your licence key may have expired or may not have been installed correctly.

See Section 8 in the Introduction to the NAG Library FL Interface for further information.

$\mathbf{ifail}=-999$

Dynamic memory allocation failed.

See Section 9 in the Introduction to the NAG Library FL Interface for further information.

7 Accuracy

8 Parallelism and Performance

9 Further Comments

10 Example

10.1 Program Text

10.2 Program Data

10.3 Program Results