libssh2/share/man/man3/libssh2_sftp_mkdir_ex.3

   1 .\" $Id: libssh2_sftp_mkdir_ex.3,v 1.6 2007/06/13 16:41:33 jehousley Exp $
   2 .\"
   3 .TH libssh2_sftp_mkdir_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual"
   4 .SH NAME
   5 libssh2_sftp_mkdir_ex - create a directory on the remote file system
   6 .SH SYNOPSIS
   7 #include <libssh2.h>
   8 #include <libssh2_sftp.h>
   9
  10 int
  11 libssh2_sftp_mkdir_ex(LIBSSH2_SFTP *sftp, const char *path, unsigned int path_len, long mode);
  12
  13 int
  14 libssh2_sftp_mkdir(LIBSSH2_SFTP *sftp, const char *path, long mode);
  15
  16 .SH DESCRIPTION
  17 \fIsftp\fP - SFTP instance as returned by
  18 .BR libssh2_sftp_init(3)
  19
  20 \fIpath\fP - full path of the new directory to create. Note that the new
  21 directory's parents must all exist priot to making this call.
  22
  23 \fIpath_len\fP - length of the full path of the new directory to create.
  24
  25 \fImode\fP - directory creation mode (e.g. 0755).
  26
  27 Create a directory on the remote file system.
  28
  29 .SH RETURN VALUE
  30 Return 0 on success or negative on failure.
  31 LIBSSH2_ERROR_EAGAIN when it would otherwise block. While
  32 LIBSSH2_ERROR_EAGAIN is a negative number, it isn't really a failure per se.
  33
  34 .SH ERRORS
  35 \fILIBSSH2_ERROR_ALLOC\fP -  An internal memory allocation call failed.
  36
  37 \fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket.
  38
  39 \fILIBSSH2_ERROR_SOCKET_TIMEOUT\fP -
  40
  41 \fILIBSSH2_ERROR_SFTP_PROTOCOL\fP - An invalid SFTP protocol response was
  42 received on the socket, or an SFTP operation caused an errorcode to be
  43 returned by the server.
  44
  45 .SH SEE ALSO
  46 .BR libssh2_sftp_opendir(3)