Downloads a remote file and saves it to the specified stream.

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

Syntax

C#
public bool DownloadFile(
	string remoteFileName,
	BinaryWriter writer,
	Object userState
)
Visual Basic
Public Function DownloadFile ( _
	remoteFileName As String, _
	writer As BinaryWriter, _
	userState As Object _
) As Boolean

Parameters

remoteFileName
Type: System..::..String
The remote file name.
writer
Type: System.IO..::..BinaryWriter
The writer.
userState
Type: System..::..Object
An object representing state for all events fired during this operation.

Return Value

trueTruetruetrue (True in Visual Basic) if the file was fully downloaded, falseFalsefalsefalse (False in Visual Basic) if the download was cancelled.

Exceptions

ExceptionCondition
System..::..ArgumentNullExceptionA parameter is nullNothingnullptra null reference (Nothing in Visual Basic).
System..::..ArgumentExceptionA file name parameter had 0-length.
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