Discuss this help topic in SecureBlackbox Forum

TElSFTPServer.OnRequestAttributes

TElSFTPServer     See also     


Filter: C#/Java  VB.NET  Pascal  C++  PHP  


This event is fired when your software has to retrieve the attributes for a specified file

Declaration

[C#/Java]
    event TSBSFTPServerRequestAttributesEvent OnRequestAttributes;
    delegate void TSBSFTPServerRequestAttributesEvent(object Sender, string Path, bool FollowSymLinks, TElSftpFileAttributes Attributes, ref int ErrorCode, ref string Comment)

[VB.NET]
    Event OnRequestAttributes As TSBSFTPServerRequestAttributesEvent
    Delegate Sub TSBSFTPServerRequestAttributesEvent(ByVal Sender As Object, ByVal Path As String, ByVal FollowSymLinks As Boolean, ByVal Attributes As TElSftpFileAttributes, ByRef ErrorCode As Integer, ByRef Comment As String)

[Pascal]
    property OnRequestAttributes: TSBSFTPServerRequestAttributesEvent;
    TSBSFTPServerRequestAttributesEvent = procedure(Sender : TObject; const Path : string; FollowSymLinks : boolean; Attributes : TElSftpFileAttributes; var ErrorCode : integer; var Comment : string) of object;

[C++]
    void get_OnRequestAttributes(TElSFTPServerRequestAttributesEvent &pMethodOutResult, void * &pDataOutResult);
    void set_OnRequestAttributes(TElSFTPServerRequestAttributesEvent pMethodValue, void * pDataValue);
    typedef void (SB_CALLBACK *TElSFTPServerRequestAttributesEvent)(void * _ObjectData, TObjectHandle Sender, const char * pcPath, int32_t szPath, int8_t FollowSymLinks, TElSftpFileAttributesHandle Attributes, int32_t &ErrorCode, char * pcComment, int32_t &szComment);

[PHP]
    TElSFTPServerRequestAttributesEvent|callable|NULL get_OnRequestAttributes()
    void set_OnRequestAttributes(TElSFTPServerRequestAttributesEvent|callable|NULL $Value)
    callable TElSFTPServerRequestAttributesEvent(TObject $Sender, string $Path, bool $FollowSymLinks, TElSftpFileAttributes $Attributes, integer &$ErrorCode, string &$Comment)

Parameters

  • Path - path name
  • FollowSymLinks - specifies whether SFTP should follow symbolic links
  • Attributes - object with attributes
  • ErrorCode - the error code, see values below
  • Comment - server comment
  • pcPath - path name
  • szPath - the length of pcPath.
  • pcComment - server comment
  • szComment - the length of pcComment.

Error codes values:


Description

    This event is fired when file attributes are required.
The application can return the error code in ErrorCode parameter and textual comment in Comment parameter.

See also:     OnRequestAttributes2     OnSetAttributes     OnSetAttributes2     OnRequestAbsolutePath     OnExtendedRequest    

Discuss this help topic in SecureBlackbox Forum