Asynchronously places the interaction on hold or takes it off hold.

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

Syntax

C#
public void HoldAsync(
	bool on,
	AsyncCompletedEventHandler completedCallback,
	Object userState
)
Visual Basic
Public Sub HoldAsync ( _
	on As Boolean, _
	completedCallback As AsyncCompletedEventHandler, _
	userState As Object _
)

Parameters

on
Type: System..::..Boolean
If set to trueTruetruetrue (True in Visual Basic), on.
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

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.

This method will raise the PerformingAction event and (if the action was not cancelled) the PerformedAction event. When those events are raised, the two events' arguments (ActionParameters and ActionParameters, respectively) will contain an entry for On.

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 GA and beyond.

See Also