generic-library/ssh2
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

clarified the return code

Browse Source
This commit is contained in:
Daniel Stenberg 2010-04-17 09:55:24 +02:00
parent 1adcb5234f
commit 81e63b3657
1 changed files with 26 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

37
docs/libssh2_sftp_symlink_ex.3
View File

@ -4,22 +4,28 @@
.SH NAME .SH NAME
libssh2_sftp_symlink_ex - read or set a symbolic link libssh2_sftp_symlink_ex - read or set a symbolic link
.SH SYNOPSIS .SH SYNOPSIS
.nf
#include <libssh2.h> #include <libssh2.h>
#include <libssh2_sftp.h> #include <libssh2_sftp.h>
int int
libssh2_sftp_symlink_ex(LIBSSH2_SFTP *sftp, const char *path, unsigned int path_len, char *target, unsigned int target_len, int link_type); libssh2_sftp_symlink_ex(LIBSSH2_SFTP *sftp, const char *path,
unsigned int path_len, char *target,
unsigned int target_len, int link_type);
int int
libssh2_sftp_symlink(LIBSSH2_SFTP *sftp, const char *path, char *target); libssh2_sftp_symlink(LIBSSH2_SFTP *sftp, const char *path, char *target);
int int
libssh2_sftp_readlink(LIBSSH2_SFTP *sftp, const char *path, char *target, unsigned int target_len); libssh2_sftp_readlink(LIBSSH2_SFTP *sftp, const char *path, char *target,
unsigned int target_len);
int int
libssh2_sftp_realpath(LIBSSH2_SFTP *sftp, const char *path, char *target, unsigned int target_len); libssh2_sftp_realpath(LIBSSH2_SFTP *sftp, const char *path, char *target,
unsigned int target_len);
.SH DESCRIPTION .SH DESCRIPTION
Create a symlink or read out symlink information from the remote side.
\fIsftp\fP - SFTP instance as returned by \fIsftp\fP - SFTP instance as returned by
.BR libssh2_sftp_init(3) .BR libssh2_sftp_init(3)
@ -28,19 +34,24 @@ libssh2_sftp_realpath(LIBSSH2_SFTP *sftp, const char *path, char *target, unsign
\fIpath_len\fP - Length of the name of the remote filesystem object to \fIpath_len\fP - Length of the name of the remote filesystem object to
create a symlink from or resolve. create a symlink from or resolve.
\fItarget\fP - \fItarget\fP - a pointer to a buffer. The buffer has different uses depending
what the \fIlink_type\fP argument is set to.
.br .br
\fBLIBSSH2_SFTP_SYMLINK\fP: Remote filesystem object to link to. \fBLIBSSH2_SFTP_SYMLINK\fP: Remote filesystem object to link to.
.br .br
\fBLIBSSH2_SFTP_READLINK\fP: Pre-allocated buffer to resolve symlink target into. \fBLIBSSH2_SFTP_READLINK\fP: Pre-allocated buffer to resolve symlink target
into.
.br .br
\fBLIBSSH2_SFTP_REALPATH\fP: Pre-allocated buffer to resolve realpath target into. \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. \fItarget_len\fP - Length of the name of the remote filesystem target object.
\fIlink_type\fP - One of the three previously mentioned constants which \fIlink_type\fP - One of the three previously mentioned constants which
determines the resulting behavior of this function. determines the resulting behavior of this function.
These are convenience macros:
.BR libssh2_sftp_symlink(3) .BR libssh2_sftp_symlink(3)
: Create a symbolic link between two filesystem objects. : Create a symbolic link between two filesystem objects.
.br .br
@ -49,12 +60,16 @@ determines the resulting behavior of this function.
.br .br
.BR libssh2_sftp_realpath(3) .BR libssh2_sftp_realpath(3)
: Resolve a complex, relative, or symlinked filepath to its effective target. : Resolve a complex, relative, or symlinked filepath to its effective target.
.SH RETURN VALUE .SH RETURN VALUE
Return 0 on success or negative on failure. It returns When using LIBSSH2_SFTP_SYMLINK, this funtion returns 0 on success or negative
LIBSSH2_ERROR_EAGAIN when it would otherwise block. While on failure.
LIBSSH2_ERROR_EAGAIN is a negative number, it isn't really a failure per se.
When using LIBSSH2_SFTP_READLINK or LIBSSH2_SFTP_REALPATH, it returns the
number of bytes it copied to the target buffer (not including the terminating
zero) 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 .SH ERRORS
\fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed. \fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed.