Definition:

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



aLIBRETURN aFile_Read(

aIOLib ioRef, aFileRef fileRef, char* pBuffer, const unsigned long nLength, unsigned long* pActuallyRead, aErr* pErr);

Parameters:

ioRef	-	A pointer to the opaque library reference used when reading from the file.
fileRef	-	A aFileRef reference that represents the file to be read.
pBuffer	-	A pointer the the data that will be read into.
nLength	-	The number of characters that should be read.
pActuallyRead	-	If this pointer is not NULL , the number of characters actually read will be stored in the unsigned long this pointer points to.
pErr	-	A pointer to an aErr variable that receives the error code on exit from this routine.

Return Value:

This library routine returns an aLIBRETURN type that is non-zero if there are errors, and zero if the routine completes with no errors.

Description:

This reads raw, unformatted characters from the aFileRef specified.  The routine will fail with a aErrMode error if the file permissions don't allow reading.  This routine tries to read the requested number of bytes and will return the actual number read if a pointer is provided.

Related:

aFile_Open, aFile_Close, aFile_Write, aFile_Seek, aFile_GetSize, aFile_Delete