Definition:

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



aLIBRETURN aStream_Read(

aIOLib ioRef, aStreamRef streamRef, char* pBuffer, const unsigned long nLength, 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 is to receive the bytes read in.
nLength	-	The number of bytes to be read from the stream.
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 raw byte data from an aStreamRef stream reference object.  If the stream is not readable, an aErrMode error occurs.  The caller is responsible for making sure there is enough free storage pointed to by pBuffer to accommodate the data being read.

Related:

aStream_Create, aStream_CreateFileInput, aStream_CreateSerial, aStream_Write