TElSftpClient.QueryHomeDirectory method

TElSftpClient.QueryHomeDirectory

Requests path to the user's home directory.

Declaration

[C#]
bool QueryHomeDirectory(string Username);

[VB.NET]
Function QueryHomeDirectory(ByVal Username As String) As Boolean

[Pascal]
function QueryHomeDirectory(const Username : string): Boolean;
procedure QueryHomeDirectorySync(const Username: string);

[C++]
bool QueryHomeDirectory(const std::string &Username);

[PHP]
bool QueryHomeDirectory(string $Username)

[Java]
boolean queryHomeDirectory(String Username);

Parameters

Return value

True if operation was completed successfully;
False otherwise.

Description

Use this method to request path to the user's home directory. If the operation succeeds, OnName event is fired, otherwise, OnError event is fired.