Discuss this help topic in SecureBlackbox Forum

TElSFTPServer.OnTextSeek

TElSFTPServer     


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


This event is fired when your software has to move current file pointer to the specified text line

Declaration

[C#]
    event TElSFTPServerTextSeekEvent OnTextSeek;
    delegate void TElSFTPServerTextSeekEvent(Object Sender, Object Data, long LineNumber, ref int ErrorCode, ref string Comment);

[VB.NET]
    Event OnTextSeek As TElSFTPServerTextSeekEvent
    Delegate Sub TElSFTPServerTextSeekEvent(ByVal Sender As Object, ByVal Data As Object, ByVal LineNumber As Long, ByRef ErrorCode As Integer, ByRef Comment As String)

[Pascal]
    property OnTextSeek: TSBSFTPServerTextSeekEvent;
    TSBSFTPServerTextSeekEvent = procedure(Sender : TObject; const Data: pointer; LineNumber : Int64; var ErrorCode : integer; var Comment : string) of object;

[C++]
    void get_OnTextSeek(TElSFTPServerTextSeekEvent &pMethodOutResult, void * &pDataOutResult);
    void set_OnTextSeek(TElSFTPServerTextSeekEvent pMethodValue, void * pDataValue);
    typedef void (SB_CALLBACK *TElSFTPServerTextSeekEvent)(void * _ObjectData, TObjectHandle Sender, void * Data, int64_t LineNumber, int32_t &ErrorCode, char * pcComment, int32_t &szComment);

[PHP]
    TElSFTPServerTextSeekEvent|callable|NULL get_OnTextSeek()
    void set_OnTextSeek(TElSFTPServerTextSeekEvent|callable|NULL $Value)
    callable TElSFTPServerTextSeekEvent(TObject $Sender, TSBPointer|NULL $Data, integer $LineNumber, integer &$ErrorCode, string &$Comment)

[Java]
    TElSFTPServerTextSeekEvent getOnTextSeek();
    void setOnTextSeek(TElSFTPServerTextSeekEvent Value);
    TElSFTPServerTextSeekEvent.Callback OnTextSeek = new TElSFTPServerTextSeekEvent.Callback() {
        public void TElSFTPServerTextSeekEventCallback(TObject Sender, TObject Data, long LineNumber, TSBInteger ErrorCode, TSBString Comment) {
            //...
        }
    }

Parameters

  • Data - user data associated with the opened file
  • LineNumber - number of string which pointer must be moved to.
  • ErrorCode - the error code, see values below
  • Comment - server comment
  • pcComment - server comment
  • szComment - the length of pcComment.

Error codes values:

Description

    This event is fired when current file pointer has to be moved to the specified string.
The application can return the error code in ErrorCode parameter and textual comment in Comment parameter.

Discuss this help topic in SecureBlackbox Forum