ClientSftpChannel - Download

[C]

__cdecl FlowSshC_ClientSftpChannel_Download(
  FlowSshC_ClientSftpChannel* channel,
  wchar_t const* remotePath,
  wchar_t const* localPath,
  unsigned int transferFlags,
  FlowSshC_TransferHandler handler,
  void* handlerData);

[C++]

[ClientSftpChannel] void Download(
  wchar_t const* remotePath,
  wchar_t const* localPath,
  unsigned int transferFlags,
  RefPtr<TransferHandler> const& transfer);

[C#]

[ClientSftpChannel] public void Download(
  string remotePath,
  string localPath,
  TransferFlags transferFlags,
  TransferHandler transfer);

Parameters

• [C] channel: FlowSshC_ClientSftpChannel pointer.
• [C] handler: A TransferHandler function to be used with the request. Optional.
• [C] handlerData: An application-defined value to be passed to the handler. Optional.
   
• remotePath: A string that specifies the name of the remote file. *
• localPath: A string that specifies the name of the local file. *
• transferFlags: A TransferFlags bitflag enumeration.
   
• [C++/.NET] transfer: A TransferHandler object to be used with the request. Optional.

Remarks

Initiates a download operation. You can track the operation through the supplied transfer handler.
* See ClientSftpChannel's remarks about local and remote file namings.