Starts an asynchronous request to query and watch parameter values.
Namespace: ININ.IceLib.StatisticsAssembly: ININ.IceLib.Statistics (in ININ.IceLib.Statistics.dll) Version: 0.0.0.0 (22.3.0.218)
Syntax
C# |
---|
public void StartWatchingQueryAsync( AssociatedParameterSetQuery query, EventHandler<AsyncCompletedEventArgs> completedCallback, Object userState ) |
Visual Basic |
---|
Public Sub StartWatchingQueryAsync ( _ query As AssociatedParameterSetQuery, _ completedCallback As EventHandler(Of AsyncCompletedEventArgs), _ userState As Object _ ) |
Parameters
- query
- Type: ININ.IceLib.Statistics..::..AssociatedParameterSetQuery
Definition of the query.
- completedCallback
- Type: System..::..EventHandler<(Of <(<'AsyncCompletedEventArgs>)>)>
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
Parameter value watches can be qualified. Qualifying a parameter query consists of using a chain
of associated parameter values to specify how to interpret the requested parameter ID. For example, requesting
parameter values for users and qualifying it by specifying a workgroup parameter with the value of 'Operator' will
result in a list of users who are in the 'Operator' workgroup. When qualifying parameters, order is important.
Not all parameters allow for searching with no qualifications. Details on what associated parameters must
be used can be found by examining the contents of the StatisticCatalog. The
RequiredParametersDefinition in StatisticDefinition provides the list of required
associated parameters. Parameter value watches do not support filtered watches, if filtered values are needed
use ExecuteQuery(ParameterQuery) instead.
When completed, the completedCallback delegate is invoked on a thread appropriate to the application-model, such as the GUI thread in a UI application. The Error property of the AsyncCompletedEventArgs-derived object passed to the delegate will contain any exceptions thrown while executing the asynchronous task. See the synchronous version of this method for more detailed error information. For more information on async method calls, see How Async Calls Work.
Note |
---|
For more information on watches see How Watches Work. |
Exceptions
Exception | Condition |
---|---|
System..::..InvalidOperationException | A watch has already been started for this instance of ParameterValuesDepot. |
System..::..ArgumentNullException | query is nullNothingnullptra null reference (Nothing in Visual Basic). |
System..::..ArgumentException | query is empty. |
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 4.0, supported for IC Server version 4.0 GA and beyond.