ssh2/docs/libssh2_sftp_mkdir_ex.3
James Housley cf8f4d1818 To simplify the user's error interface always use LIBSSH2_ERROR_EAGAIN.
LIBSSH2CHANNEL_EAGAIN and LIBSSH2SFTP_EAGAIN are still valid, but are
defined as LIBSSH2_ERROR_EAGAIN.
2007-06-08 13:33:08 +00:00

29 lines
1008 B
Groff

.\" $Id: libssh2_sftp_mkdir_ex.3,v 1.3 2007/06/08 13:33:08 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. 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 "SEE ALSO"
.BR libssh2_sftp_opendir(3)