Downloads this FaxMessage into a specified file.

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 bool SaveAsFile(
	FaxAttachment attachment,
	string fileName,
	bool markAsRead
)
Visual Basic
Public Function SaveAsFile ( _
	attachment As FaxAttachment, _
	fileName As String, _
	markAsRead As Boolean _
) As Boolean

Parameters

attachment
Type: ININ.IceLib.UnifiedMessaging..::..FaxAttachment
The FaxAttachment of this message to download.
fileName
Type: System..::..String
The path and name of a local file to save the fax into.
markAsRead
Type: System..::..Boolean
Mark this message as read.

Return Value

trueTruetruetrue (True in Visual Basic) if the file was saved successfully.

Exceptions

ExceptionCondition
System..::..ArgumentNullExceptionA parameter is nullNothingnullptra null reference (Nothing in Visual Basic).
System..::..ArgumentExceptionIf the fileName length is zero.
ININ.IceLib.Connection..::..RequestTimeoutExceptionThe request timed out while waiting for a response.
ININ.IceLib.Connection..::..SessionDisconnectedExceptionThe Session does not have a valid connection.
System..::..ObjectDisposedExceptionThe Session has been disposed.

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