TElSimpleSftpClient.QueryHomeDirectory method

TElSimpleSFTPClient.QueryHomeDirectory

Requests path to the user's home directory.

Declaration

[C#]
void QueryHomeDirectory(string Username, TElSftpFileInfo HomeDir);

[VB.NET]
Sub QueryHomeDirectory(ByVal Username As String, ByVal HomeDir As TElSftpFileInfo)

[Pascal]
procedure QueryHomeDirectory(const Username : string; HomeDir : TElSftpFileInfo);

[C++]
void QueryHomeDirectory(const std::string &Username, TElSftpFileInfo &HomeDir);
void QueryHomeDirectory(const std::string &Username, TElSftpFileInfo *HomeDir);

[PHP]
void QueryHomeDirectory(string $Username, TElSftpFileInfo $HomeDir)

[Java]
void queryHomeDirectory(String Username, TElSftpFileInfo HomeDir);

Parameters

Username - username for which the home directory is requested
HomeDir - an initialized object into which information about home directory will be put

Description

Use this method to request path to the user's home directory.
In case of error, EElSFTPError exception containing SFTP error code, is raised. For more information on error handling, please read the corresponding how-to article.