FTP Function Reference

sFTPDownloadDirectory

FTP Function Reference

This function downloads a remote directory and any containing files and sub directories.

<DllImport("SapphireFTP.dll")> _
Public Function sFTPDownloadDirectory(ByVal sRemoteDirectory As String, ByVal sLocalPath As String, ByVal lLicence As Integer) As Integer
End Function

Parameters

  sRemoteDirectory
    A string specifying the name of the remote directory to download.
  sLocalPath
    A string specifying the path on the local device where to download the remote directory to.
  lLicence
    An integer specifying the licence number of the registered utility. If using in demo mode, enter 1234567890.

Return Values

  Returns a number indicating success or failure. If the operation was successful then the return value will be FTP_NO_ERROR. Use sFTPErrorText to get a string version of the error message.

Remarks

  The same directory must not already exist on the local drive otherwise an error will occur.

The local path must not include a trailing slash.

The function will only download up to 10 sub directories per directory node.