Click or drag to resize

HelperFunctionsSettingsManager Class

The SettingsManager Class contains methods to manage a Binary Setting File, including file read and write, and the actual Setting add/remove/update functions.
Inheritance Hierarchy
SystemObject
  AHLHelperFunctionsSettingsManager

Namespace:  AHL
Assembly:  AHL (in AHL.dll) Version: 1.0.0.0 (1.0.0.0)
Syntax
public static class SettingsManager

The HelperFunctionsSettingsManager type exposes the following members.

Methods
  NameDescription
Public methodStatic memberAddSetting
This method will Add a new setting to the Settings file. If you have not called InitializeSettingsFile() a generic one called "Settings.dat" will be created or opened.
Public methodStatic memberBackupSettings
This method will backup the current Settings file into a "bak" file.
Public methodStatic memberGetSetting
This method will return a setting from the Settings file. If you have not called InitializeSettingsFile() a generic one called "Settings.dat" will be created or opened.
Public methodStatic memberGetSettingLength
This method will return the number of settings in your Settings file
Public methodStatic memberGetSettingsDictionary
This method will return the Dictionary which contains all your settings. If you have not called InitializeSettingsFile() a generic one called "Settings.dat" will be created or opened.
Public methodStatic memberInitializeSettingsFile
This method will initialize a binary setting file for saving your settings. If you have not called InitializeSettingsFile() a generic one called "Settings.dat" will be created or opened.
Public methodStatic memberLoadSettings
This method will load the settings from the Settings file. This will be calleed automatically each time you Initialize the settings, but will need to be manually called if you want to read from the file.
Public methodStatic memberRemoveSetting
This method will Remove a setting from the Settings file. If you have not called InitializeSettingsFile() a generic one called "Settings.dat" will be created or opened.
Public methodStatic memberRestoreSettings
This method will restore the Settings file from the available "bak" file.
Public methodStatic memberSaveSettings
This method will save the settings into the chosen binary file. This will be called automatically each time you add/remove/update. This shouldn't be called manually, but the option is anyway granted to the user.
Public methodStatic memberUpdateSetting
This method will let you update a setting from the Settings file. If you have not called InitializeSettingsFile() a generic one called "Settings.dat" will be created or opened.
Top
See Also

Reference