Discuss this help topic in SecureBlackbox Forum

TElSftpClient.CreateSymLink

TElSftpClient     See also     


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


Creates the new symbolic link on a server

Declaration

[C#/Java]
    bool CreateSymLink(string LinkPath, string TargetPath);

[VB.NET]
    Function CreateSymLink(ByVal LinkPath As String, ByVal TargetPath As String) As Boolean

[Pascal]
    function CreateSymLink(LinkPath : string; TargetPath : string): Boolean;
    procedure CreateSymLinkSync(const LinkPath: string; const TargetPath: string);

[C++]
    bool CreateSymLink(const std::string &LinkPath, const std::string &TargetPath);

[PHP]
    bool CreateSymLink(string $LinkPath, string $TargetPath)

Parameters

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

Return value

    True if operation was completed successfully;
    False otherwise.

Description

    Use this method to create symbolic links on a server side. If the symbolic link was successfully created, the OnSuccess event is fired. The OnError event is fired otherwise.

See also:     ReadSymLink     CreateHardLink    

Discuss this help topic in SecureBlackbox Forum