aIO Data TypesIndex

aIOLib Type

This is an opaque type that represents the aIO Library.  The actual underlying implementation of this depends on the platform and may change at any time.  To obtain a reference to the library for use in calling all library routines, use the aIO_GetLibRef routine and when you are done with it, be sure to call aIO_ReleaseLibRef routine to free up any resources used by the library.

aFileRef Type

This is an opaque type that represents a file.  The actual underlying implementation of this depends on the platform and may change at any time.  This type is used in all places where files are to be written or read from the operating system.  Using this file abstraction will enable you to port your code across platforms by just recompiling.  This file reference can be created using the aFile_Open routine and can be closed using the aFile_Close routine.  Your may want to consider using a aStreamRef type instead as it is a higher level type and offers more functionality than this low level type.

aFileMode Type

This is an enum that defines the available file modes when creating or opening aFileRef files using the aFile_Open routine.  There are currently two modes supported, aFileModeReadOnly and aFileModeWriteOnly.

aFileArea Type

This is an enum that defines the available file locations for creating or opening files.  The current options are:

aUser - Source .tea files and other files created by the user.
aSystem - System files that should not be modified or edited.
aObject - Generated files created by the compiler, etc.
aBinary - Binary executable files.  Also configuration files and any trace debugging files.
aTest - Test files used internally for testing releases.
aAsset - Static resource files for various applications.
aPlugin - Plugin code for applications using a plugin architecture.

aFILE_NAMEMAXCHARS

This is a #define that specifies the maximum number of characters in a file name, regardless of platform.


version: 1.0, build n.a.
© Copyright 1994-2012 Acroname, Inc., Boulder, Colorado.  All rights reserved.