Discuss this help topic in SecureBlackbox Forum

TElSFTPServer.OnRequestAttributes

TElSFTPServer     See also     


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


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

Declaration

[C#]
    event TElSFTPServerRequestAttributesEvent OnRequestAttributes;
    delegate void TElSFTPServerRequestAttributesEvent(Object Sender, string Path, bool FollowSymLinks, TElSftpFileAttributes Attributes, ref int ErrorCode, ref string Comment);

[VB.NET]
    Event OnRequestAttributes As TElSFTPServerRequestAttributesEvent
    Delegate Sub TElSFTPServerRequestAttributesEvent(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)

[Java]
    TElSFTPServerRequestAttributesEvent getOnRequestAttributes();
    void setOnRequestAttributes(TElSFTPServerRequestAttributesEvent Value);
    TElSFTPServerRequestAttributesEvent.Callback OnRequestAttributes = new TElSFTPServerRequestAttributesEvent.Callback() {
        public void TElSFTPServerRequestAttributesEventCallback(TObject Sender, String Path, boolean FollowSymLinks, TElSftpFileAttributes Attributes, TSBInteger ErrorCode, TSBString 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:

SSH_ERROR_FILE_IS_A_DIRECTORY 24 (0x0018) The specified file was a directory in a context where a directory cannot be used
SSH_ERROR_BYTE_RANGE_LOCK_CONFLICT 25 (0x0019) A read or write operation failed because another process's mandatory byte-range lock overlaps with the request SSH_ERROR_BYTE_RANGE_LOCK_REFUSED 26 (0x001A) A request for a byte range lock was refused SSH_ERROR_DELETE_PENDING 27 (0x001B) An operation was attempted on a file for which a delete operation is pending SSH_ERROR_FILE_CORRUPT 28 (0x001C) The file is corrupt; an filesystem integrity check should be run SSH_ERROR_OWNER_INVALID 29 (0x001D) The principal specified can not be assigned as an owner of a file SSH_ERROR_GROUP_INVALID 30 (0x001E) The principal specified can not be assigned as the primary group of a file SSH_ERROR_UNSUPPORTED_VERSION 100 (0x0064) Sets of supported by client and server versions has no intersection SSH_ERROR_INVALID_PACKET 101 (0x0065) Invalid packet was received SSH_ERROR_TUNNEL_ERROR 102 (0x0066) Error is on the SSH-protocol level. The connection is closed because of SSH error SSH_ERROR_CONNECTION_CLOSED 103 (0x0067) Connection is closed SSH_ERROR_UNSUPPORTED_ACTION 104 (0x0068) … SSH_ERROR_NOT_A_TEXT_HANDLE 105 (0x0069) … SSH_ERROR_CANCELLED_BY_USER 106 (0x006A) … Declared in [.NET] [Pascal] [C++] Namespace: SBSftpCommon
Assembly: SecureBlackbox.SFTPCommon Unit: SBSftpCommon sbsftpcommon.h

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