Definition:

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



aLIBRETURN aSettingFile_Create(

aIOLib ioRef, const unsigned int nMaxSettingLen, const char* pFileName, aSettingFileRef* pSettingFileRef, aErr* pErr);

Parameters:

ioRef	-	A reference to the aIO library used to create the setting file.
nMaxSettingLen	-	The maximum length of a setting name for this file.  Settings in the file with longer names will be truncated.
pFileName	-	The C string file name that will be used to create the settings.  There is no assumed extension and the file is sought in the aBinary directory of the BrainStem file structure.
pSettingFileRef	-	A pointer to the setting file object reference that is set upon successful completion of this routine.  This is an opaque reference.
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 creates a setting file object based on the specified file.  The file is sought in the aBinary directory.  No restrictions are placed on the file name but the convention of the application name followed by ".config" is highly recommended.  Various access routines can be used with the setting file object to retieve settings of different basic types or defaults if the setting is not specified.  Any setting file object created with this routine must be properly destroyed using the aSettingFile_Destroy routine.

Related:

aSettingFile_Destroy, Config Files