Definition:

#include <aIO.h>
object code: aIO shared library



aLIBRETURN aStream_ReadLine(

aIOLib ioRef, aStreamRef streamRef, char* pBuffer, const unsigned long nMaxLength, aErr* pErr);

Parameters:

ioRef	-	A reference to the aIO library used to read from the stream.
streamRef	-	The stream reference that is used for reading.  This must be a readable stream.
pBuffer	-	A pointer to memory that will receive a null-terminated, C-style string.
nMaxLength	-	The maximum length of string that can be read in.
pErr	-	A pointer to an aErr variable that receives the error code on exit from this routine.

Return Value:

This library routine returns zero for no errors, and non-zero for errors.

Description:

This routine reads in an entire line from the stream up to the end-of-line .  The line returned is null-terminated and is truncated to the number of bytes specified by nMaxLength if the line is too long.  If the stream is not readable, an aErrMode error occurs.  The caller is responsible for making sure there is at least nMaxLength bytes of free storage pointed to by pBuffer to accommodate the data being read.  Using this routine as well as the aStream_WriteLine routine ensures cross-platform handling of text files on a line-by-line basis.

Related:

aStream_Create, aStream_CreateFileInput, aStream_CreateSerial, aStream_Read, aStream_Write, aStream_WriteLine