Starts watching the currently logged in user.
Namespace: ININ.IceLib.ConfigurationAssembly: ININ.IceLib.Configuration (in ININ.IceLib.Configuration.dll) Version: 0.0.0.0 (22.3.0.218)
Syntax
C# |
---|
public void StartWatchingLoggedInUserAsync( IEnumerable<UserConfiguration..::..Property> selectedProperties, AsyncCompletedEventHandler completedCallback, Object userState ) |
Visual Basic |
---|
Public Sub StartWatchingLoggedInUserAsync ( _ selectedProperties As IEnumerable(Of UserConfiguration..::..Property), _ completedCallback As AsyncCompletedEventHandler, _ userState As Object _ ) |
Parameters
- selectedProperties
- Type: System.Collections.Generic..::..IEnumerable<(Of <(<'UserConfiguration..::..Property>)>)>
The properties to watch.
- completedCallback
- Type: System.ComponentModel..::..AsyncCompletedEventHandler
The callback to invoke when the asynchronous operation completes.
- userState
- Type: System..::..Object
An optional object that contains state information for this request. This object is a way for the caller to store context information which will be provided to the AsyncCompleted event. If no context information is desired then nullNothingnullptra null reference (Nothing in Visual Basic) may be supplied.
Remarks
StartWatchingLoggedInUserAsync asynchronously starts a watch on the currently logged in user. After
the watch is started GetConfigurationList()()()()
can be used to retrieve the currently logged in user object. Use
StopWatching()()()() to stop this watch.
Note |
---|
All event handlers should be added before calling StartWatchingLoggedInUser(IEnumerable<(Of <<'(UserConfiguration..::..Property>)>>)) or StartWatchingLoggedInUserAsync(IEnumerable<(Of <<'(UserConfiguration..::..Property>)>>), AsyncCompletedEventHandler, Object). |
Note |
---|
For more information on watches see How Watches Work. |
Exceptions
Exception | Condition |
---|---|
System..::..ArgumentNullException | A parameter is nullNothingnullptra null reference (Nothing in Visual Basic). |
System..::..InvalidOperationException | The ConfigurationList<(Of <(<'TConfigurationObject, TPropertyEnum>)>)> is already watched or 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.
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.