Discuss this help topic in SecureBlackbox Forum

TElSFTPServer.OnRequestAbsolutePath

TElSFTPServer     See also     


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


This event is fired when your software has to canonicalize any given path name to the absolute path.

Declaration

[C#/Java]
    event TElSFTPServerRequestAbsolutePathEvent OnRequestAbsolutePath;
    delegate void TElSFTPServerRequestAbsolutePathEvent(Object Sender, string Path, ref string AbsolutePath, TSBSftpRealpathControl Control, TElStringList ComposePath, ref int ErrorCode, ref string Comment);

[VB.NET]
    Event OnRequestAbsolutePath As TElSFTPServerRequestAbsolutePathEvent
    Delegate Sub TElSFTPServerRequestAbsolutePathEvent(ByVal Sender As Object, ByVal Path As String, ByRef AbsolutePath As String, ByVal Control As TSBSftpRealpathControl, ByVal ComposePath As TElStringList, ByRef ErrorCode As Integer, ByRef Comment As String)

[Pascal]
    property OnRequestAbsolutePath: TSBSFTPServerRequestAbsolutePathEvent;
    TSBSFTPServerRequestAbsolutePathEvent = procedure(Sender : TObject; const Path : string; var AbsolutePath : string; Control : TSBSftpRealpathControl; ComposePath : TStringList; var ErrorCode: integer; var Comment : string) of object;

[C++]
    void get_OnRequestAbsolutePath(TElSFTPServerRequestAbsolutePathEvent &pMethodOutResult, void * &pDataOutResult);
    void set_OnRequestAbsolutePath(TElSFTPServerRequestAbsolutePathEvent pMethodValue, void * pDataValue);
    typedef void (SB_CALLBACK *TElSFTPServerRequestAbsolutePathEvent)(void * _ObjectData, TObjectHandle Sender, const char * pcPath, int32_t szPath, char * pcAbsolutePath, int32_t &szAbsolutePath, TSBSftpRealpathControlRaw Control, TStringListHandle ComposePath, int32_t &ErrorCode, char * pcComment, int32_t &szComment);

[PHP]
    TElSFTPServerRequestAbsolutePathEvent|callable|NULL get_OnRequestAbsolutePath()
    void set_OnRequestAbsolutePath(TElSFTPServerRequestAbsolutePathEvent|callable|NULL $Value)
    callable TElSFTPServerRequestAbsolutePathEvent(TObject $Sender, string $Path, string &$AbsolutePath, integer $Control, TStringList $ComposePath, integer &$ErrorCode, string &$Comment)

Parameters

  • Path - path name
  • AbsolutePath - absolute path to be returned
  • Control - manages possible ways of the path transforming
  • ComposePath - A path which the client wishes the server to compose with the original path to form the new path.
  • ErrorCode - the error code, see values below
  • Comment - server comment
  • pcPath - path name
  • szPath - the length of pcPath.
  • pcAbsolutePath - absolute path to be returned
  • szAbsolutePath - the length of pcAbsolutePath.
  • pcComment - server comment
  • szComment - the length of pcComment.

Control values:


Error codes values:


Description

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

See also:     OnRequestAttributes     OnRequestAttributes2     OnExtendedRequest    

Discuss this help topic in SecureBlackbox Forum