NAG CL Interface
x04bbc (line_​read)

Settings help

CL Name Style:


1 Purpose

x04bbc reads a single line from an external file.

2 Specification

#include <nag.h>
void  x04bbc (Nag_FileID fileid, char *line, Integer linelen, NagError *fail)
The function may be called by the names: x04bbc, nag_file_line_read or nag_read_line.

3 Description

x04bbc may be used to read from files opened with x04acc.

4 References

None.

5 Arguments

1: fileid Nag_FileID Input
On entry: the identifier of the file to be read from. This must have been returned by a call of x04acc.
2: 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: linelen Integer Input
On entry: the size of the character buffer line. If linelen0, no characters are read and line is unchanged.
4: fail NagError * Input/Output
The NAG error argument (see Section 7 in the Introduction to the NAG Library CL Interface).

6 Error Indicators and Warnings

NE_READ_ERROR
Error occurred when reading from FileID value.

7 Accuracy

Not applicable.

8 Parallelism and Performance

Background information to multithreading can be found in the Multithreading documentation.
x04bbc is not threaded in any implementation.

9 Further Comments

None.

10 Example

See x04acc.