TElSimpleSFTPClient.CreateHardLink method

TElSimpleSFTPClient.CreateHardLink

TElSimpleSFTPClient See also

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

Creates a new hard-link.

Declaration

[C#]
void CreateHardLink(string LinkPath, string TargetPath);

[VB.NET]
Sub CreateHardLink(ByVal LinkPath As String, ByVal TargetPath As String)

[Pascal]
procedure CreateHardLink(const LinkPath : string; const TargetPath : string);

[C++]
void CreateHardLink(const std::string &LinkPath, const std::string &TargetPath);

[PHP]
void CreateHardLink(string $LinkPath, string $TargetPath)

[Java]
void createHardLink(String LinkPath, String TargetPath);

Parameters

LinkPath - specifies the name for a newly created hard link
TargetPath - specifies the target of hard link

Return value

Returns True if the operation was completed successfully, and False otherwise.

Description

    Use this method to create hard links on the server side.
    In case of error, EElSFTPError exception containing the SFTP error code, is raised. For more information on error handling, please read the corresponding how-to article.
    It is generally not possible to create hard links across devices.
    This feature is supported since version 6 of the SFTP protocol.