Back to FlowSsh Documentation

ClientSftpChannel - List

[C]

__cdecl FlowSshC_ClientSftpChannel_List(
  FlowSshC_ClientSftpChannel* channel,
  wchar_t const* path,
  FlowSshC_ListHandler handler,
  void* handlerData);

[C++]

[ClientSftpChannel] void List(
  wchar_t const* path,
  RefPtr<ListHandler> const& list);

[C#]

[ClientSftpChannel] public void List(
  string path,
  ListHandler list);

Parameters

  • [C] channel: FlowSshC_ClientSftpChannel pointer.
  • [C] handler: A ListHandler function to be used with the request. Required.
  • [C] handlerData: An application-defined value to be passed to the handler. Optional.
     
  • path: A valid remote directory. *
  • [Cpp/Net] list: A ListHandler object to be used with the request. Required.

Remarks

Initiates a listing operation on the remote directory. The resulting file list is returned through the registered list-handler which may be invoked multiple times.
* See ClientSftpChannel's remarks about local and remote file namings.