libssh2_sftp_symlink_ex

Section: libssh2 manual (3)
Updated: 1 Jun 2007
Index Return to Main Contents

NAME

libssh2_sftp_symlink_ex - read or set a symbolic link

SYNOPSIS

#include <libssh2.h> #include <libssh2_sftp.h>

int libssh2_sftp_symlink_ex(LIBSSH2_SFTP *sftp, const char *path, unsigned int path_len, char *target, unsigned int target_len, int link_type);

int libssh2_sftp_symlink(LIBSSH2_SFTP *sftp, const char *path, char *target);

int libssh2_sftp_readlink(LIBSSH2_SFTP *sftp, const char *path, char *target, unsigned int target_len);

int libssh2_sftp_realpath(LIBSSH2_SFTP *sftp, const char *path, char *target, unsigned int target_len);

DESCRIPTION

sftp - SFTP instance as returned by libssh2_sftp_init(3)

path - Remote filesystem object to create a symlink from or resolve.

path_len - Length of the name of the remote filesystem object to create a symlink from or resolve.

target -
LIBSSH2_SFTP_SYMLINK: Remote filesystem object to link to.
LIBSSH2_SFTP_READLINK: Pre-allocated buffer to resolve symlink target into.
LIBSSH2_SFTP_REALPATH: Pre-allocated buffer to resolve realpath target into.

target_len - Length of the name of the remote filesystem target object.

link_type - One of the three previously mentioned constants which determines the resulting behavior of this function.

libssh2_sftp_symlink(3) : Create a symbolic link between two filesystem objects.
libssh2_sftp_readlink(3) : Resolve a symbolic link filesystem object to its next target.
libssh2_sftp_realpath(3) : Resolve a complex, relative, or symlinked filepath to its effective target.

RETURN VALUE

Return 0 on success or negative on failure. It returns LIBSSH2_ERROR_EAGAIN when it would otherwise block. While LIBSSH2_ERROR_EAGAIN is a negative number, it isn't really a failure per se.

ERRORS

LIBSSH2_ERROR_ALLOC - An internal memory allocation call failed.

LIBSSH2_ERROR_SOCKET_SEND - Unable to send data on socket.

LIBSSH2_ERROR_SOCKET_TIMEOUT -