Legend

Class
Struct
Enum
Interface
Delegate
Constructor
Method
Property
Event
Field

Constructor: SettingsFile<TSettings>(string, SettingsLocation, bool, string)

  • Declared in: RT.Serialization.Settings.SettingsFile<TSettings>

Declaration

public SettingsFile<TSettings>(
    string appName,
    SettingsLocation location,
    bool throwOnError,
    string suffix
)

Summary

Configures the location of the settings file and loads or initialises the settings. See Remarks on SettingsFile<TSettings>.

Parameters

stringappName Application name; used as the settings folder name and to construct the settings file name and the portable marker file name.
SettingsLocationlocation Determines where to store the settings file.
boolthrowOnError If true, any errors while loading the file are silently suppressed and a default instance is loaded instead. If false, such errors are propagated to the caller as exceptions. This value is also used as the default value for throwOnError when calling SettingsFile<TSettings>.Save(bool?).
stringsuffix Appended to the settings file name; at a minimum this should include the extension dot and the file extension.