A synchronous 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 StartWatchingQuery( AssociatedParameterSetQuery query ) |
Visual Basic |
---|
Public Sub StartWatchingQuery ( _ query As AssociatedParameterSetQuery _ ) |
Parameters
- query
- Type: ININ.IceLib.Statistics..::..AssociatedParameterSetQuery
Definition of the query.
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.
Note |
---|
For more information on watches see How Watches Work. |
Exceptions
Exception | Condition |
---|---|
System..::..ArgumentNullException | query is nullNothingnullptra null reference (Nothing in Visual Basic). |
System..::..InvalidOperationException | This ParameterValuesDepot is already watched. |
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.