SettingReadOptions Enum

Definition

Defines the requirements for reading settings via ISettingsReader.

This enumeration supports a bitwise combination of its member values.

[System.Flags]
public enum SettingReadOptions
[<System.Flags>]
type SettingReadOptions = 
Public Enum SettingReadOptions
Inheritance
SettingReadOptions
Attributes

Fields

Name Value Description
NoRequirements 0

Return the stored value without performing any checks.

RequireRegistration 1

Fail if the setting is not registered.

RequireValidation 3

Fail if the setting is not registered or not valid according to the registration.

NoFallbackToDefault 4

Return an error rather than the default value if the persisted value can't be converted to the target type or if validation is requested and the persisted value doesn't pass validation criteria.

ApplyMigration 9

Apply the "migration" transform from the setting registration, returning a value compatible with the legacy schema. Fails if the setting isn't registered, the registration doesn't include migration, or the migration can't be applied to the current setting value.

Applies to