SSH.SFTPSession.ReadSymbolicLink - charonn0/RB-libssh2 GitHub Wiki
SSH.SFTPSession.ReadSymbolicLink
Method Signature
Function ReadSymbolicLink(LinkPath As String, FollowAll As Boolean = False) As String
Parameters
| Name | Type | Comment |
|---|---|---|
LinkPath |
String | The path of the link to follow. |
FollowAll |
Boolean | Optional. If True then symlinks to symlinks are dereferenced. |
Return value
Returns the path contained within the symlink, or the empty string.
Remarks
Reads the symbolic link specified by LinkPath and returns the path of the linked file/directory. If the linked file/directory is itself a symlink and FollowAll=True then that and all subsequent symlinks are followed until we reach the final target.
If the LinkPath is not actually a symlink then this method returns the empty string.