php8.5
Home/ Manual/ ssh2 / functions/ ssh2_sftp_readlink

ssh2_sftp_readlink

PHP function Edit on GitHub ✎

(PECL ssh2 >= 0.9.0)

Return the target of a symbolic link

Description

ssh2_sftp_readlink(resource $sftp, string $link): string|false

Returns the target of a symbolic link.

Parameters

sftp

An SSH2 SFTP resource opened by ssh2_sftp().

link

Path of the symbolic link.

Return Values

Returns the target of the symbolic linkFalseforfailure.

Examples

Reading a symbolic link

php
<?php
$connection = ssh2_connect('shell.example.com', 22);
ssh2_auth_password($connection, 'username', 'password');
$sftp = ssh2_sftp($connection);

$target = ssh2_sftp_readlink($sftp, '/tmp/mysql.sock');
/* $target is now (e.g.): '/var/run/mysql.sock' */
?>

See Also

Source: reference/ssh2/functions/ssh2-sftp-readlink.xml · from the official PHP manual (php/doc-en)