StatHandler Class

[C++]

class StatHandler : public HandlerBase (.. public RefCountable, public NoCopy)
{
public:
  bool Success() const;
  FileAttrs GetFileAttrs() const;
  SftpErr GetError() const;

protected:
  virtual void OnStart();
  virtual void OnDone();
  virtual void OnStat(FileAttrs const& fileAttrs);
  virtual void OnError(SftpErr const& error);
}

[C#]

public class StatHandler : IDisposable, HandlerBase (.. WaitImpl)
{
  public bool Success { get; }
  public SftpErr GetError();
  
  public event StartEventHandler OnStart;
  public event DoneEventHandler OnDone;
  public event StatEventHandler OnStat;
  public event SftpErrorEventHandler OnError;
  
  public override sealed bool IsDisposed { get; }
  public override sealed void Dispose();
}

Members

General

• Success: Request completed successfully?
• GetFileAttrs: Returns a FileAttrs with information about the requested file.
• GetError: Returns a SftpErr.

Overrides and Events

• OnStart: The first override/event being invoked for a request. *
• OnDone: The last override/event being invoked for a request. *
• OnStat: Invoked to pass the received file information to you.
  Parameters:
  • fileAttrs: See GetFileAttrs().
• OnError: Invoked for a failed request.
  Parameters:
  • error: See GetError().

[.NET] Disposing

• IsDisposed: Is the object disposed?
• Dispose: Release all resources used by the object.

Remarks

StatHandler is a base class which must be derived to use. Either derive and implement your own OnDone() method, or use pre-made derived classes StatEvent or StatMsg (for Win32 graphical applications). If you use StatEvent, call WaitDone() or wait for GetDoneEvent() before checking the result.

This handler is used with with the [ClientSftpChannel]Stat request.

* [C++] Always call the base class implementation from your override.