TElSFTPServer.OnRequestAbsolutePath event

TElSFTPServer.OnRequestAbsolutePath

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

Declaration

[C#]
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)

[Java]
    TElSFTPServerRequestAbsolutePathEvent getOnRequestAbsolutePath();
    void setOnRequestAbsolutePath(TElSFTPServerRequestAbsolutePathEvent Value);
    TElSFTPServerRequestAbsolutePathEvent.Callback OnRequestAbsolutePath = new TElSFTPServerRequestAbsolutePathEvent.Callback() {
        public void TElSFTPServerRequestAbsolutePathEventCallback(TObject Sender, String Path, TSBString AbsolutePath, TSBSftpRealpathControl Control, TElStringList ComposePath, TSBInteger ErrorCode, TSBString 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:

[.NET] [C++]	[Pascal]	Description
rcNoCheck = 0	rcNoCheck	The server will not fail the request if the path does not exist,is hidden, or the user does not have access to the path or some component thereof.However, the path may not be completely resolved to its component form.For example, symlinks may not be followed in this case.The server may fail the request if the path is not syntactically valid, or for other reasons
rcStatIf = 1	rcStatIf	The server will stat the path if it exists and is accessible to the client.However, if the path does not exist, isn't visible, or isn't accessible, the server will not fail the request. If the stat failed, the filetype will be SSH_FILEXFER_TYPE_UNKNOWN
rcStatAlways = 2	rcStatAlways	The server will stat the path.If the stat operation fails, the server will fail the request

Error codes values:

Definition	Value	Description
SSH_ERROR_WRONG_MODE	-1 (0xFFFFFFFF)	Attempt to call synchronous method in asynchronous mode and vice versa
SSH_ERROR_OK	0 (0x0000)	Indicates successful completion of the operation
SSH_ERROR_EOF	1 (0x0001)	indicates end-of-file condition; Read: no more data is available in the file; ReadDirectory: no more files are contained in the directory
SSH_ERROR_NO_SUCH_FILE	2 (0x0002)	A reference is made to a file which does not exist
SSH_ERROR_PERMISSION_DENIED	3 (0x0003)	the authenticated user does not have sufficient permissions to perform the operation
SSH_ERROR_FAILURE	4 (0x0004)	An error occurred for which there is no more specific error code defined
SSH_ERROR_BAD_MESSAGE	5 (0x0005)	A badly formatted packet or protocol incompatibility is detected
SSH_ERROR_NO_CONNECTION	6 (0x0006)	A pseudo-error which indicates that the client has no connection to the server
SSH_ERROR_CONNECTION_LOST	7 (0x0007)	A pseudo-error which indicates that the connection to the server has been lost
SSH_ERROR_OP_UNSUPPORTED	8 (0x0008)	An attempt was made to perform an operation which is not supported for the server
SSH_ERROR_INVALID_HANDLE	9 (0x0009)	The handle value was invalid
SSH_ERROR_NO_SUCH_PATH	10 (0x000A)	The file path does not exist or is invalid
SSH_ERROR_FILE_ALREADY_EXISTS	11 (0x000B)	The file already exists
SSH_ERROR_WRITE_PROTECT	12 (0x000C)	The file is on read only media, or the media is write protected
SSH_ERROR_NO_MEDIA	13 (0x000D)	The requested operation can not be completed because there is no media available in the drive
SSH_ERROR_NO_SPACE_ON_FILESYSTEM	14 (0x000E)	The requested operation cannot be completed because there is no free space on the filesystem
SSH_ERROR_QUOTA_EXCEEDED	15 (0x000F)	The operation cannot be completed because it would exceed the user's storage quota
SSH_ERROR_UNKNOWN_PRINCIPAL	16 (0x0010)	A principal referenced by the request (either the ‘owner’,‘group’, or ‘who’ field of an ACL), was unknown
SSH_ERROR_LOCK_CONFLICT	17 (0x0011)	The file could not be opened because it is locked by another process
SSH_ERROR_DIR_NOT_EMPTY	18 (0x0012)	The directory is not empty
SSH_ERROR_NOT_A_DIRECTORY	19 (0x0013)	The specified file is not a directory
SSH_ERROR_INVALID_FILENAME	20 (0x0014)	The filename is not valid
SSH_ERROR_LINK_LOOP	21 (0x0015)	Too many symbolic links encountered
SSH_ERROR_CANNOT_DELETE	22 (0x0016)	The file cannot be deleted. One possible reason is that the advisory READONLY attribute-bit is set
SSH_ERROR_INVALID_PARAMETER	23 (0x0017)	On of the parameters was out of range, or the parameters specified cannot be used together
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)	…

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.

Discuss this help topic in SecureBlackbox Forum