Downloads this FaxMessage into a specified stream.
Namespace: ININ.IceLib.UnifiedMessagingAssembly: ININ.IceLib.UnifiedMessaging (in ININ.IceLib.UnifiedMessaging.dll) Version: 0.0.0.0 (22.3.0.218)
Syntax
C# |
---|
public bool SaveToStream( FaxAttachment attachment, Stream stream, bool markAsRead ) |
Visual Basic |
---|
Public Function SaveToStream ( _ attachment As FaxAttachment, _ stream As Stream, _ markAsRead As Boolean _ ) As Boolean |
Parameters
- attachment
- Type: ININ.IceLib.UnifiedMessaging..::..FaxAttachment
The FaxAttachment of this message to download.
- stream
- Type: System.IO..::..Stream
The stream 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
Exception | Condition |
---|---|
System..::..ArgumentNullException | A parameter is nullNothingnullptra null reference (Nothing in Visual Basic). |
ININ.IceLib.Connection..::..RequestTimeoutException | The request timed out while waiting for a response. |
ININ.IceLib.Connection..::..SessionDisconnectedException | The Session does not have a valid connection. |
System..::..ObjectDisposedException | The 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 SU 2 and beyond.
For 4.0, supported for IC Server version 4.0 SU 2 and beyond.