Gets the configuration list.

Namespace: ININ.IceLib.Configuration
Assembly: ININ.IceLib.Configuration (in ININ.IceLib.Configuration.dll) Version: 0.0.0.0 (21.2.0.218)

Syntax

C#
public ReadOnlyCollection<TConfigurationObject> GetConfigurationList()
Visual Basic
Public Function GetConfigurationList As ReadOnlyCollection(Of TConfigurationObject)

Return Value

A list of configuration objects matching the filter and sort specified by the QuerySettings<(Of <(<'TConfigurationObject, TPropertyEnum>)>)> passed to StartCaching(QuerySettings<(Of <<'(TConfigurationObject, TPropertyEnum>)>>)).

Remarks

If an object in the returned configuration list is of the type EditableListConfigurationObject<(Of <(<'TPropertyEnum>)>)> and the object's settings are going to be modified, PrepareForEdit()()()() must be called first. Once the object's settings have been modified, use Commit()()()() or CommitAsync(AsyncCompletedEventHandler, Object) to commit the setting modifications to the server. Alternatively CancelEdit()()()() can be called to cancel any setting modifications.
Note
Accessing this property before a watch is started which includes this property raises a NotCachedException. A watch must be started first. For more information on watches see How Watches Work.

Exceptions

ExceptionCondition
ININ.IceLib..::..NotCachedExceptionThe specified object is not being cached.

Version Information

Supported for IC Server version 2015 R1 and beyond.
For 4.0, supported for IC Server version 4.0 GA and beyond.
For 3.0, supported for IC Server version 3.0 SU 7 and beyond.

See Also