IAppConfigServiceRegisterSetting Method |
Register a configuration setting so that it may be assigned a value and saved in the configuration.
Namespace:
Dundas.BI.Configuration
Assembly:
Dundas.BI.Core (in Dundas.BI.Core.dll) Version: 2.0.0.0 (9.0.0.1000)
SyntaxAppSetting RegisterSetting(
AppSettingProperties properties
)
Function RegisterSetting (
properties As AppSettingProperties
) As AppSetting
AppSetting^ RegisterSetting(
AppSettingProperties^ properties
)
abstract RegisterSetting :
properties : AppSettingProperties -> AppSetting
Parameters
- properties
- Type: Dundas.BI.ConfigurationAppSettingProperties
The properties of the setting to be registered.
Return Value
Type:
AppSettingAn
AppSetting object representing the setting.
Exceptions| Exception | Condition |
|---|
| ArgumentNullException | properties is . |
| DuplicateItemException | A setting with the same ID and/or (module ID / name) combination has already been registered. |
| ValidationException | The properties of the setting did not pass validation criteria. |
Remarks
This method must be called after the engine is started.
For information on validation criteria, refer to the documentation of AppSettingProperties
and its members.
See Also