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

Document libssh2_sftp_mkdir_ex() and libssh2_sftp_mkdirnb_ex()

Browse Source
This commit is contained in:
James Housley 2007-04-22 19:51:53 +00:00
parent a66885c51c
commit 54e6528822
3 changed files with 58 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
docs/Makefile.am
View File

@ -1,4 +1,4 @@
# $Id: Makefile.am,v 1.4 2007/04/21 18:07:17 jehousley Exp $ # $Id: Makefile.am,v 1.5 2007/04/22 19:51:53 jehousley Exp $
EXTRA_DIST = template.3 EXTRA_DIST = template.3
@ -9,4 +9,5 @@ dist_man_MANS = libssh2_channel_forward_accept.3 \
libssh2_sftp_open_ex.3 libssh2_channel_set_blocking.3 \ libssh2_sftp_open_ex.3 libssh2_channel_set_blocking.3 \
libssh2_session_free.3 libssh2_poll.3 libssh2_poll_channel_read.3 \ libssh2_session_free.3 libssh2_poll.3 libssh2_poll_channel_read.3 \
libssh2_sftp_read.3 libssh2_sftp_readnb.3 libssh2_sftp_readdir.3 \ libssh2_sftp_read.3 libssh2_sftp_readnb.3 libssh2_sftp_readdir.3 \
libssh2_sftp_readdirnb.3 libssh2_sftp_readdirnb.3 libssh2_sftp_mkdir_ex.3 \
libssh2_sftp_mkdirnb_ex.3

26
docs/libssh2_sftp_mkdir_ex.3 Normal file
View File

@ -0,0 +1,26 @@
.\" $Id: libssh2_sftp_mkdir_ex.3,v 1.1 2007/04/22 19:51:53 jehousley Exp $
.\"
.TH libssh2_sftp_mkdir_ex 3 "16 Apr 2007" "libssh2 0.15" "libssh2 manual"
.SH NAME
libssh2_sftp_mkdir_ex - create a directory on the remote file system
.SH SYNOPSIS
#include <libssh2.h>
#include <libssh2_sftp.h>
int libssh2_sftp_mkdir_ex(LIBSSH2_SFTP *sftp, const char *path,
unsigned int path_len, long mode);
.SH DESCRIPTION
\fIsftp\fP SFTP instance as returned by \fIlibssh2_sftp_init(3)\fP.
\fIpath\fP full path of the new directory to create. Note that the new
directory's parents must all exist priot to making this call.
\fIpath_len\fP length of the full path of the new directory to create.
\fImode\fP directory creation mode (e.g. 0755).
.SH RETURN VALUE
0 on success, or -1 on failure.
.SH "SEE ALSO"
.BR libssh2_sftp_opendir(3)

29
docs/libssh2_sftp_mkdirnb_ex.3 Normal file
View File

@ -0,0 +1,29 @@
.\" $Id: libssh2_sftp_mkdirnb_ex.3,v 1.1 2007/04/22 19:51:54 jehousley Exp $
.\"
.TH libssh2_sftp_mkdir_ex 3 "16 Apr 2007" "libssh2 0.15" "libssh2 manual"
.SH NAME
libssh2_sftp_mkdir_ex - create a directory on the remote file system in
non-blocking mode
.SH SYNOPSIS
#include <libssh2.h>
#include <libssh2_sftp.h>
int libssh2_sftp_mkdir_ex(LIBSSH2_SFTP *sftp, const char *path,
unsigned int path_len, long mode);
.SH DESCRIPTION
\fIsftp\fP SFTP instance as returned by \fIlibssh2_sftp_init(3)\fP.
\fIpath\fP full path of the new directory to create. Note that the new
directory's parents must all exist priot to making this call.
\fIpath_len\fP length of the full path of the new directory to create.
\fImode\fP directory creation mode (e.g. 0755).
.SH RETURN VALUE
0 on success, or -1 on failure. It returns LIBSSH2CHANNEL_EAGAIN when
it would otherwise block. While LIBSSH2CHANNEL_EAGAIN is a negative
number, it isn't really a failure per se.
.SH "SEE ALSO"
.BR libssh2_sftp_opendir(3)