Back to FlowSsh Documentation

ClientSftpChannel - Rename

[C]

__cdecl FlowSshC_ClientSftpChannel_Rename(
  FlowSshC_ClientSftpChannel* channel,
  wchar_t const* oldPath,
  wchar_t const* newPath,
  FlowSshC_SftpHandler handler,
  void* handlerData);

[C++]

[ClientSftpChannel] void Rename(
  wchar_t const* oldPath,
  wchar_t const* newPath,
  RefPtr<SftpHandler> const& response);

[C#]

[ClientSftpChannel] public void Rename(
  string oldPath,
  string newPath,
  SftpHandler response);

Parameters

  • [C] channel: FlowSshC_ClientSftpChannel pointer.
  • [C] handler: A SftpHandler function to be used with the request. Optional.
  • [C] handlerData: An application-defined value to be passed to the handler. Optional.
     
  • oldPath: Name of an existing remote file or directory. *
  • newPath: New name (and possibly path) for the remote file or directory. *
     
  • [Cpp/Net] response: A SftpHandler object to be used with the request. Optional.

Remarks

Renames (if the name changes) and possibly moves (if the path changes) a remote file or directory.
* See ClientSftpChannel's remarks about local and remote file namings.