TElSftpClient.RequestAbsolutePathEx method

TElSftpClient.RequestAbsolutePathEx

Asks the server to canonicalize any given path name to the absolute path.

Declaration

[C#]
bool RequestAbsolutePathEx(string Path, TSBSftpRealpathControl Control, TElStringList ComposePath);

[VB.NET]
Function RequestAbsolutePathEx(ByVal Path As String, ByVal Control As TSBSftpRealpathControl, ByVal ComposePath As TElStringList) As Boolean

[Pascal]
function RequestAbsolutePathEx(Path : string; Control : TSBSFTPRealpathControl; ComposePath : TStringList): Boolean;
function RequestAbsolutePathExSync(const Path: string; Control : TSBSFTPRealpathControl; ComposePath : TStringList): string;

[C++]
bool RequestAbsolutePathEx(const std::string &Path, TSBSftpRealpathControl Control, TStringList &ComposePath);
bool RequestAbsolutePathEx(const std::string &Path, TSBSftpRealpathControl Control, TStringList *ComposePath);

[PHP]
bool RequestAbsolutePathEx(string $Path, integer $Control, TStringList $ComposePath)

[Java]
boolean requestAbsolutePathEx(String Path, TSBSftpRealpathControl Control, TElStringList ComposePath);

Parameters

Path - path name
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.

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

Return value

True if operation was completed successfully;
False otherwise.

Description

Use this method to make server canonicalize any path name to the absolute path. This is useful for converting path names containing «..» components or relative pathnames without a leading slash into absolute paths. If the path was successfully canonicalized, the OnAbsolutePath event is fired. The OnError event is fired otherwise.

Discuss this help topic in SecureBlackbox Forum