Back to FlowSsh Documentation

ClientSftpChannel - RmDir

[C]

__cdecl FlowSshC_ClientSftpChannel_RmDir(
  FlowSshC_ClientSftpChannel* channel,
  wchar_t const* path,
  FlowSshC_SftpHandler handler,
  void* handlerData);

[C++]

[ClientSftpChannel] void RmDir(
  wchar_t const* path,
  RefPtr<SftpHandler> const& response);

[C#]

[ClientSftpChannel] public void RmDir(
  string path,
  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.
     
  • path: The remote directory to be deleted. *
  • [Cpp/Net] response: A SftpHandler object to be used with the request. Optional.

Remarks

Deletes a remote directory. The directory must be empty for the request to succeed, because RmDir is not a recursive operation. To delete a file use [ClientSftpChannel]Remove.
* See ClientSftpChannel's remarks about local and remote file namings.