Asynchronously subscribes to the specified alert set.

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

Syntax

C#
public void SubscribeAsync(
	AlertSet alertSet,
	bool subscribeFlag,
	AsyncCompletedEventHandler completedCallback,
	Object userState
)
Visual Basic
Public Sub SubscribeAsync ( _
	alertSet As AlertSet, _
	subscribeFlag As Boolean, _
	completedCallback As AsyncCompletedEventHandler, _
	userState As Object _
)

Parameters

alertSet
Type: ININ.IceLib.Statistics.Alerts..::..AlertSet
The alert set.
subscribeFlag
Type: System..::..Boolean
if set to trueTruetruetrue (True in Visual Basic) subscribe to alert set, else if set to falseFalsefalsefalse (False in Visual Basic) unsubscribe from the alert set.
completedCallback
Type: System.ComponentModel..::..AsyncCompletedEventHandler
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

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..::..ArgumentNullExceptionalertSet is nullNothingnullptra null reference (Nothing in Visual Basic).
System..::..InvalidOperationExceptionCannot perform subscribe operation on default alert set.
System..::..ExceptionAn unexpected exception occurred while subscribing.

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