Executes a query for parameter values and returns the results asynchronously.

Namespace: ININ.IceLib.Statistics
Assembly: ININ.IceLib.Statistics (in ININ.IceLib.Statistics.dll) Version: 0.0.0.0 (22.3.0.218)

Syntax

C#
public void ExecuteQueryAsync(
	ParameterQuery query,
	EventHandler<ParameterQueryCompletedEventArgs> completedCallback,
	Object userState
)
Visual Basic
Public Sub ExecuteQueryAsync ( _
	query As ParameterQuery, _
	completedCallback As EventHandler(Of ParameterQueryCompletedEventArgs), _
	userState As Object _
)

Parameters

query
Type: ININ.IceLib.Statistics..::..ParameterQuery
The ParameterQuery to execute.
completedCallback
Type: System..::..EventHandler<(Of <(<'ParameterQueryCompletedEventArgs>)>)>
The completed callback.
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 queries can be qualified or filtered. 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. Filtering a parameter query consists of specifying a string and limiting the result set to those values that match the provided string. A query that is completely unfiltered and unqualified can use ParameterQuery, however if a qualification or filter is needed FilteredParameterQuery must be used. Note that not all parameters allow for searching with no qualifications, in these cases FilteredParameterQuery must be used for results to be returned. 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.

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.

Exceptions

ExceptionCondition
System..::..ArgumentNullExceptionThe query parameter is nullNothingnullptra null reference (Nothing in Visual Basic).

Version Information

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

See Also