Discuss this help topic in SecureBlackbox Forum

TElSFTPServer.OnCloseHandle

TElSFTPServer     


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


This event is fired when your software has to close the handle.

Declaration

[C#/Java]
    event TSBSFTPServerCloseHandleEvent OnCloseHandle;
    delegate void TSBSFTPServerCloseHandleEvent(object Sender, object Data, ref int ErrorCode, ref string Comment)

[VB.NET]
    Public Event OnCloseHandle As TSBSFTPServerCloseHandleEvent
    Delegate Sub TSBSFTPServerCloseHandleEvent(ByVal Sender As Object, ByVal Data As Object, ByRef ErrorCode As Integer, ByRef Comment As String)

[Pascal]
    property OnCloseHandle: TSBSFTPServerCloseHandleEvent;
    
    TSBSFTPServerCloseHandleEvent = procedure(Sender : TObject; Data: pointer; var ErrorCode : integer; var Comment : string) of object;
    type TSBSftpFileHandle = ByteArray;

[C++]
    void get_OnCloseHandle(TElSFTPServerCloseHandleEvent &pMethodOutResult, void * &pDataOutResult);
    void set_OnCloseHandle(TElSFTPServerCloseHandleEvent pMethodValue, void * pDataValue);
    typedef void (SB_CALLBACK *TElSFTPServerCloseHandleEvent)(void * _ObjectData, TObjectHandle Sender, void * Data, int32_t &ErrorCode, char * pcComment, int32_t &szComment);

[PHP]
    TElSFTPServerCloseHandleEvent|callable|NULL get_OnCloseHandle()
    void set_OnCloseHandle(TElSFTPServerCloseHandleEvent|callable|NULL $Value)
    callable TElSFTPServerCloseHandleEvent(TObject $Sender, TSBPointer|NULL $Data, integer &$ErrorCode, string &$Comment)

Parameters

  • Data - user data associated with the opened file
  • ErrorCode - the error code, see values below
  • Comment - server comment
  • pcComment - server comment
  • szComment - the length of pcComment.

Error codes


Description

    This event is fired when the handle has to be closed. The application can return the error code in ErrorCode parameter and textual comment in Comment parameter.

Discuss this help topic in SecureBlackbox Forum