From 70ea2c776e8853fcde9342530dfbc156bf8e898b Mon Sep 17 00:00:00 2001 From: James Housley Date: Wed, 13 Jun 2007 15:10:45 +0000 Subject: [PATCH] Update to match current code and add errors --- docs/libssh2_sftp_mkdir_ex.3 | 36 +++++++++++++++++++++++++++--------- 1 file changed, 27 insertions(+), 9 deletions(-) diff --git a/docs/libssh2_sftp_mkdir_ex.3 b/docs/libssh2_sftp_mkdir_ex.3 index 8901f13..e3f84f7 100644 --- a/docs/libssh2_sftp_mkdir_ex.3 +++ b/docs/libssh2_sftp_mkdir_ex.3 @@ -1,28 +1,46 @@ -.\" $Id: libssh2_sftp_mkdir_ex.3,v 1.4 2007/06/13 12:51:11 jehousley Exp $ +.\" $Id: libssh2_sftp_mkdir_ex.3,v 1.5 2007/06/13 15:10:45 jehousley Exp $ .\" -.TH libssh2_sftp_mkdir_ex 3 "16 Apr 2007" "libssh2 0.15" "libssh2 manual" +.TH libssh2_sftp_mkdir_ex 3 "1 June 2007" "libssh2 0.15" "libssh2 manual" .SH NAME libssh2_sftp_mkdir_ex - create a directory on the remote file system .SH SYNOPSIS #include #include -int libssh2_sftp_mkdir_ex(LIBSSH2_SFTP *sftp, const char *path, - unsigned int path_len, long mode); +int +libssh2_sftp_mkdir_ex(LIBSSH2_SFTP *sftp, const char *path, unsigned int path_len, long mode); + +int +libssh2_sftp_mkdir(LIBSSH2_SFTP *sftp, const char *path, long mode); .SH DESCRIPTION -\fIsftp\fP SFTP instance as returned by \fIlibssh2_sftp_init(3)\fP. +\fIsftp\fP - SFTP instance as returned by +.BR libssh2_sftp_init(3) -\fIpath\fP full path of the new directory to create. Note that the new +\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. +\fIpath_len\fP - length of the full path of the new directory to create. -\fImode\fP directory creation mode (e.g. 0755). +\fImode\fP - directory creation mode (e.g. 0755). + +Create a directory on the remote file system. .SH RETURN VALUE -0 on success, or -1 on failure. It returns +Return 0 on success or negative on failure. 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_opendir(3)