Back to FlowSsh Documentation

ListHandler Typedef

[C]

typedef bool (__cdecl* FlowSshC_ListHandler)(
  void* handlerData,
  FlowSshC_FileInfo const* fileInfos,
  unsigned int nrFileInfos, bool endOfList,
  FlowSshC_ListErr const* error);

Parameters

  • handlerData: Data passed to the initiating call.
  • fileInfos: An array of FileInfo structures.
  • nrFileInfos: Number of elements in the array.
  • endOfList: This handler can be called multiple times. On success the last call will have endOfList=true, error!=NULL.
  • error: Pointer to a ListErr structure. This pointer is NULL on success.

Return Value

Return false to cancel the listing.

Remarks

A list handler can be called multiple times. On success the last call will have endOfList=true, error!=NULL. If you return false or if an error occurs, the listing is canceled.