Download the file specified by the properties of this object with progress events posted to the specified listener.

Syntax

Visual Basic

Public Function DownloadFile( _
   ByVal listener As ULFileTransferProgressListener _
) As Boolean

C#

public bool DownloadFile(
   ULFileTransferProgressListener listener
);

Parameters

Return value

True if successful, false otherwise (check ULFileTransfer.StreamErrorCode and other status properties for reason).

Remarks

The file specified by the ULFileTransfer.FileName is downloaded by the MobiLink server to the ULFileTransfer.DestinationPath using the ULFileTransfer.Stream, ULFileTransfer.UserName, ULFileTransfer.Password, and ULFileTransfer.Version. Other properties that affect the download are ULFileTransfer.DestinationFileName, ULFileTransfer.AuthenticationParms, ULFileTransfer.ForceDownload and ULFileTransfer.ResumePartialDownload.

To avoid file corruption, UltraLite.NET will download to a temporary file and only replace the destination file once the download has completed.

A detailed result status is reported in this object's ULFileTransfer.AuthStatus, ULFileTransfer.AuthValue, ULFileTransfer.FileAuthCode, ULFileTransfer.DownloadedFile, ULFileTransfer.StreamErrorCode, and ULFileTransfer.StreamErrorSystem.

Errors may result in no data being sent to the listener.

See also

• ULFileTransfer class
• ULFileTransfer members
• DownloadFile methods
• FileName property
• DestinationPath property
• Stream property
• UserName property
• Password property
• Version property
• DestinationFileName property
• AuthenticationParms property
• ForceDownload property
• ResumePartialDownload property
• AuthStatus property
• AuthValue property
• FileAuthCode property
• DownloadedFile property
• StreamErrorCode property
• StreamErrorSystem property
• StreamErrorCode property