IAppConfigServiceSetValue Method |
Sets the value of a configuration setting.
Namespace:
Dundas.BI.Configuration
Assembly:
Dundas.BI.Core (in Dundas.BI.Core.dll) Version: 2.0.0.0 (8.0.2.1001)
Syntaxvoid SetValue(
Guid settingId,
AppSettingScope scope,
Object scopeTarget,
Object value
)
Sub SetValue (
settingId As Guid,
scope As AppSettingScope,
scopeTarget As Object,
value As Object
)
void SetValue(
Guid settingId,
AppSettingScope scope,
Object^ scopeTarget,
Object^ value
)
abstract SetValue :
settingId : Guid *
scope : AppSettingScope *
scopeTarget : Object *
value : Object -> unit
Parameters
- settingId
- Type: SystemGuid
The ID of the setting. - scope
- Type: Dundas.BI.ConfigurationAppSettingScope
The scope to which the value applies. - scopeTarget
- Type: SystemObject
The server name or server group ID (ignored if scope
is not Server or ServerGroup).
- value
- Type: SystemObject
The new value for the setting, or to fall back (see remarks).
Exceptions| Exception | Condition |
|---|
| ArgumentException | settingId is Empty. -or- scope is Effective. -or- scope is Server and scopeTarget
is empty, , or not a String.
-or- scope is ServerGroup and scopeTarget
is less than or equal to zero, or not an Int64.
-or- value could not be converted to the setting's type. |
| ArgumentOutOfRangeException | scope is not one of the AppSettingScope values. |
| ValidationException | value does not satisfy the setting's validation rule. |
| NotFoundException | There was no registered setting corresponding to the provided setting ID. |
| InvalidOperationException | IsOnlyGlobal is for the setting, but scope
is not Global.
|
| NoPrivilegeException | The caller does not have system administration privileges. |
| InvalidSessionException | The caller context is not associated with a valid session. |
Remarks
If the value of the setting is
, then the effective value will be inherited from
a higher scope. If the value of the setting is
in the highest scope
Global), the effective value will be the setting's default.
See Also