Asynchronously downloads this FaxMessage into a specified stream.

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

Syntax

C#
public void SaveToStreamAsync(
	FaxAttachment attachment,
	Stream stream,
	bool markAsRead,
	EventHandler<AsyncSaveAsFileCompletedEventArgs> completedCallback,
	Object userState
)
Visual Basic
Public Sub SaveToStreamAsync ( _
	attachment As FaxAttachment, _
	stream As Stream, _
	markAsRead As Boolean, _
	completedCallback As EventHandler(Of AsyncSaveAsFileCompletedEventArgs), _
	userState As Object _
)

Parameters

attachment
Type: ININ.IceLib.UnifiedMessaging..::..FaxAttachment
The FaxAttachment of this FaxMessage to download.
stream
Type: System.IO..::..Stream
The stream to save the fax into.
markAsRead
Type: System..::..Boolean
Mark this FaxMessage as read.
completedCallback
Type: System..::..EventHandler<(Of <(<'AsyncSaveAsFileCompletedEventArgs>)>)>
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.

Exceptions

ExceptionCondition
System..::..ArgumentNullExceptionA 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 SU 2 and beyond.

See Also