Asynchronously downloads an attachment into a specified stream.

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 DownloadFileAttachmentAsync(
	EmailFileAttachment emailAttachment,
	Stream outputStream,
	AsyncCompletedEventHandler completedCallback,
	Object userState
)
Visual Basic
Public Sub DownloadFileAttachmentAsync ( _
	emailAttachment As EmailFileAttachment, _
	outputStream As Stream, _
	completedCallback As AsyncCompletedEventHandler, _
	userState As Object _
)

Parameters

emailAttachment
Type: ININ.IceLib.Interactions..::..EmailFileAttachment
The EmailFileAttachment of this EmailInteraction.
outputStream
Type: System.IO..::..Stream
The Stream to which the downloaded file should be written.
completedCallback
Type: System.ComponentModel..::..AsyncCompletedEventHandler
The callback to invoke when the asynchronous operation completes.
userState
Type: System..::..Object
An object that contains state information for this request.

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).
System..::..ArgumentExceptionA parameter contains an invalid value.

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