71 lines
2.3 KiB
Groff
71 lines
2.3 KiB
Groff
|
.\" $Id: libssh2_sftp_symlink_ex.3,v 1.1 2007/06/14 16:33:38 jehousley Exp $
|
||
|
|
.\"
|
||
|
|
.TH libssh2_sftp_symlink_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual"
|
||
|
|
.SH NAME
|
||
|
|
libssh2_sftp_symlink_ex - read or set a symbolic link
|
||
|
|
.SH 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);
|
||
|
|
|
||
|
|
.SH DESCRIPTION
|
||
|
|
\fIsftp\fP - SFTP instance as returned by
|
||
|
|
.BR libssh2_sftp_init(3)
|
||
|
|
|
||
|
|
\fIpath\fP - Remote filesystem object to create a symlink from or resolve.
|
||
|
|
|
||
|
|
\fIpath_len\fP - Length of the name of the remote filesystem object to
|
||
|
|
create a symlink from or resolve.
|
||
|
|
|
||
|
|
\fItarget\fP -
|
||
|
|
.br
|
||
|
|
\fBLIBSSH2_SFTP_SYMLINK\fP: Remote filesystem object to link to.
|
||
|
|
.br
|
||
|
|
\fBLIBSSH2_SFTP_READLINK\fP: Pre-allocated buffer to resolve symlink target into.
|
||
|
|
.br
|
||
|
|
\fBLIBSSH2_SFTP_REALPATH\fP: Pre-allocated buffer to resolve realpath target into.
|
||
|
|
|
||
|
|
\fItarget_len\fP - Length of the name of the remote filesystem target object.
|
||
|
|
|
||
|
|
\fIlink_type\fP - One of the three previously mentioned constants which
|
||
|
|
determines the resulting behavior of this function.
|
||
|
|
|
||
|
|
.BR libssh2_sftp_symlink(3)
|
||
|
|
: Create a symbolic link between two filesystem objects.
|
||
|
|
.br
|
||
|
|
.BR libssh2_sftp_readlink(3)
|
||
|
|
: Resolve a symbolic link filesystem object to its next target.
|
||
|
|
.br
|
||
|
|
.BR libssh2_sftp_realpath(3)
|
||
|
|
: Resolve a complex, relative, or symlinked filepath to its effective target.
|
||
|
|
|
||
|
|
.SH 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.
|
||
|
|
|
||
|
|
.SH ERRORS
|
||
|
|
\fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed.
|
||
|
|
|
||
|
|
\fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket.
|
||
|
|
|
||
|
|
\fILIBSSH2_ERROR_SOCKET_TIMEOUT\fP -
|
||
|
|
|
||
|
|
\fILIBSSH2_ERROR_SFTP_PROTOCOL\fP - An invalid SFTP protocol response was
|
||
|
|
received on the socket, or an SFTP operation caused an errorcode to
|
||
|
|
be returned by the server.
|
||
|
|
|
||
|
|
.SH SEE ALSO
|
||
|
|
.BR libssh2_sftp_init(3)
|