Discuss this help topic in SecureBlackbox Forum

TElSftpClient.RequestAbsolutePathEx

TElSftpClient     See also     


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


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

Declaration

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

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:


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.

See also:     RequestAbsolutePath     MakeDirectory     OpenDirectory    

Discuss this help topic in SecureBlackbox Forum