fparseln — return
the next logical line from a stream
function returns a pointer to the next logical line from the stream
referenced by stream. This string is
NUL terminated and it is dynamically allocated on
each invocation. It is the responsibility of the caller to free the
By default, if a character is escaped, both it and the preceding escape character will be present in the returned string. Various flags alter this behaviour.
The meaning of the arguments is as follows:
- The stream to read from.
- If not
NULL, the length of the string is stored in the memory location to which it points.
- If not
NULL, the value of the memory location to which is pointed to, is incremented by the number of lines actually read from the file.
- Contains the escape, continuation, and comment characters. If a character
NULthen processing for that character is disabled. If
NULL, all characters default to values specified below. The contents of delim is as follows:
- The escape character, which defaults to
\, is used to remove any special meaning from the next character.
- The continuation character, which defaults to
\, is used to indicate that the next line should be concatenated with the current one if this character is the last character on the current line and is not escaped.
- The comment character, which defaults to
#, if not escaped indicates the beginning of a comment that extends until the end of the current line.
- If non-zero, alter the operation of
fparseln(). The various flags, which may be or-ed together, are:
Upon successful completion a pointer to the parsed line is
NULL is returned.
fparseln() function uses internally
getline(3), so all error conditions that apply to
getline(3), apply to
fparseln() may set
errno to [
ENOMEM] and return
NULL if it runs out of memory.
fparseln() function first appeared in
|November 30, 2002||Debian|