Definition:

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



aLIBRETURN aFile_Open(

aIOLib ioRef, const char* pFilename, const aFileMode eMode, const aFileArea eArea, aFileRef* pFileRef, aErr* pErr);

Parameters:

ioRef	-	A pointer to the opaque library reference used to open the file.
pFilename	-	The null-terminated C-style string that designates the file name.  This filename is limited to aFILE_NAMEMAXCHARS characters.
eMode	-	The mode of operation for the file being opened.  Files opened for writing that don't exist are created.  Files opened for reading that don't exist result in a aErrNotFound error.
eArea	-	The file area in which to open the file.
pFileRef	-	A pointer to a aFileRef type that is set to reference the file opened.
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 routine opens a file in a platform independent manner and returns a reference to the file for use in subsequent aFile_Read or aFile_Write routine calls (depending on the file permissions).  For more information about the specifics of how this routine works on different platforms, take a look at the Platform Specifics section of the Overview.

Related:

aFile_Close, aFile_Read, aFile_Write, aFile_Seek, aFile_GetSize, aFile_Delete