NAG Library Routine Document

x04bbf  (line_read)

1

Purpose

2

Specification

3

Description

4

References

5

Arguments

1:     $\mathbf{nin}$ – IntegerInput

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}$ – IntegerInput/Output

On entry: ifail must be set to $0$, $-1\text{ or }1$. If you are unfamiliar with this argument you should refer to Section 3.4 in How to Use the NAG Library and its Documentation for details.

For environments where it might be inappropriate to halt program execution when an error is detected, the value $-1\text{ or }1$ is recommended. If the output of error messages is undesirable, then the value $1$ is recommended. Otherwise, if you are not familiar with this argument, the recommended value is $0$. When the value $-\mathbf{1}\text{ 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$

An end-of-file was detected by the READ statement.

System-dependent errors may also occur if the unit specified by nin is not connected to an external file, or if a read error occurs.

$\mathbf{ifail}=-99$

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

See Section 3.9 in How to Use the NAG Library and its Documentation for further information.

$\mathbf{ifail}=-399$

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

See Section 3.8 in How to Use the NAG Library and its Documentation for further information.

$\mathbf{ifail}=-999$

Dynamic memory allocation failed.

See Section 3.7 in How to Use the NAG Library and its Documentation for further information.

7

Accuracy

8

Parallelism and Performance

9

Further Comments

10

Example

10.1

Program Text

Program Text (x04bbfe.f90)

10.2

Program Data

Program Data (x04bbfe.d)

10.3

Program Results

Program Results (x04bbfe.r)