Issues an asynchronous request to send a Fax.

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 SendFaxAsync(
	string fileName,
	EventHandler<AsyncSendFaxCompletedEventArgs> completedCallback,
	Object userState
)
Visual Basic
Public Sub SendFaxAsync ( _
	fileName As String, _
	completedCallback As EventHandler(Of AsyncSendFaxCompletedEventArgs), _
	userState As Object _
)

Parameters

fileName
Type: System..::..String
The file name of the Fax to send.
completedCallback
Type: System..::..EventHandler<(Of <(<'AsyncSendFaxCompletedEventArgs>)>)>
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

Use the FaxFile class to create a .TIF or .i3f formatted Fax file in the file system before sending.

Note
Most fax terminals can't handle widths larger than 1728 pixels. If the width of the Image will exceed 1728 pixels, it is recommended to store the image in portrait orientation and set the FaxPageAttributes instance to indicate that the image has been rotated.
This can also be handled by specifying FitToPage when adding or updating pages. This will cause the image to be scaled to fit on the page. If FitToPage is not specified, no resizing will be done and the image will be cropped.

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..::..ArgumentExceptionIf a fileName of length zero.

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