Back to FlowSsh Documentation

ClientSftpChannel - Stat

[C]

__cdecl FlowSshC_ClientSftpChannel_Stat(
  FlowSshC_ClientSftpChannel* channel,
  wchar_t const* path,
  unsigned int desiredAttrFlags,
  FlowSshC_StatHandler handler,
  void* handlerData);

[C++]

[ClientSftpChannel] void Stat(
  wchar_t const* path,
  unsigned int desiredAttrFlags,
  RefPtr<StatHandler> const& stat);

[C#]

[ClientSftpChannel] public void Stat(
  string path,
  AttrFlags desiredAttrFlags,
  StatHandler stat);

Parameters

  • [C] channel: FlowSshC_ClientSftpChannel pointer.
  • [C] handler: A StatHandler function to be used with the request. Required.
  • [C] handlerData: An application-defined value to be passed to the handler. Optional.
     
  • path: The remote file whose attributes are to be retrieved. *
  • desiredAttrFlags: An AttrFlags bitflag enumeration. It specifies in which attributes you are particularly interested (a hint to the server). There is no guarantee the server will indeed return all requested attributes.
     
  • [Cpp/Net] stat: A StatHandler object to be used with the request. Required.

Remarks

Stat is used to retrieve file or directory attributes.
* See ClientSftpChannel's remarks about local and remote file namings.