AC.OptionsFileHandler_SystemFile Class Reference

Inheritance diagram for AC.OptionsFileHandler_SystemFile:

Public Member Functions
void	SaveOptions (int profileID, string dataString, bool showLog)
	Saves the OptionsData, serialized as a string, to disk. More...
string	LoadOptions (int profileID, bool showLog)
	Loads the OptionsData, serialized as a string, from disk. More...
void	DeleteOptions (int profileID)
	Deletes the saved OptionsData string for a given profile. More...
int	GetActiveProfile ()
	Returns the active profile ID number, if profiles are enabled More...
void	SetActiveProfile (int profileID)
	Records the active profile ID More...
bool	DoesProfileExist (int profileID)
	Checks if OptionsData for a given profile is stored More...

Protected Member Functions
string	GetProfileFullFilename (int profileID)
string	GetActiveProfileDataFullFilename ()

Detailed Description

A file handler that stores Options data as files on the machine

Member Function Documentation

DeleteOptions()

void AC.OptionsFileHandler_SystemFile.DeleteOptions

(

int

profileID

)

Deletes the saved OptionsData string for a given profile.

Parameters

profileID

The ID number of the profile to delete</parm>

Implements AC.iOptionsFileHandler.

DoesProfileExist()

bool AC.OptionsFileHandler_SystemFile.DoesProfileExist

(

int

profileID

)

Checks if OptionsData for a given profile is stored

Parameters

profileID

The ID number of the profile to check for</parm> Returns True if OptionsData for the given profile exists

Implements AC.iOptionsFileHandler.

GetActiveProfile()

int AC.OptionsFileHandler_SystemFile.GetActiveProfile

(

)

Returns the active profile ID number, if profiles are enabled

Returns

The ID number of the active profile, or 0 if profiles are not enabled.

Implements AC.iOptionsFileHandler.

LoadOptions()

string AC.OptionsFileHandler_SystemFile.LoadOptions	(	int	profileID,
		bool	showLog
	)

Loads the OptionsData, serialized as a string, from disk.

Parameters

profileID

The ID number of the profile to be loaded, or 0 if profiles are not enabled

Returns

The OptionsData, serialized as a string

Implements AC.iOptionsFileHandler.

SaveOptions()

void AC.OptionsFileHandler_SystemFile.SaveOptions	(	int	profileID,
		string	dataString,
		bool	showLog
	)

Saves the OptionsData, serialized as a string, to disk.

Parameters

profileID	The ID number of the profile to be saved, or 0 if profiles are not enabled
dataString	The serialized data to save
showLog	If True, a Console message upon succesful saving is requested

Implements AC.iOptionsFileHandler.

SetActiveProfile()

void AC.OptionsFileHandler_SystemFile.SetActiveProfile

(

int

profileID

)

Records the active profile ID

Parameters

profileID

The ID number of the profile to set as active</parm>

Implements AC.iOptionsFileHandler.