A simple .ini file interface.
Dependents: Smart-WiFly-WebServer SignalGenerator WattEye X10Svr
Diff: IniManager.h
- Revision:
- 8:f128b10dfab1
- Parent:
- 6:cd28ab597256
- Child:
- 10:57b93035ad82
--- a/IniManager.h Thu May 22 16:09:43 2014 +0000 +++ b/IniManager.h Mon Jul 07 15:19:16 2014 +0000 @@ -45,6 +45,18 @@ */ ~INI(void); + /** Determine if a file exists + * + * This API can be used to determine if a file exists. The file may + * be specified as a parameter, but if no parameter is supplied it will + * then check to see if the INI file exists. This is either the file + * passed to the constructor, or the file passed to the SetFile API. + * + * @param[in] file is the optional filename to check for existance. + * @returns true if the file exists. + */ + bool Exists(const char * file = NULL); + /** set the file to use * * If not set at the time of construction, or if a change is needed, this @@ -87,14 +99,17 @@ private: char * iniFile; - /** Crash recover if we can. + /** Cleanup temporary files. * - * This will attempt to crash recover. If while writing a new file, it could not - * complete the process, it may be able to complete the process on the next access. + * This will attempt to clean up any temporary files. This can happen + * while writing a new file, if something went wrong and the program + * crashed or otherwise could not complete the process. + * This will look for the temp files, try to finish processing them + * and remove the extraneous. * * @return true, always until I find a reason not to. */ - bool CrashRecover(); + bool CleanUp(); /** Rename a file *