mirror of
https://github.com/libssh2/libssh2.git
synced 2025-04-26 16:48:48 +03:00
e590450dcc
- add missing `.fi` tags. - fix misplaced `.nf` tags. - add `.nf`/`.fi` tags `SYNOPSIS` where missing. - fix missing/wrong function name from `SH NAME`. - fix wrong function name in `TH`. - keep return values in a separate line. - indent. - fold long lines. - deleted `libssh2_channel_direct_streamlocal()`, there is no such function. - add missing types. - add missing headers. Closes #949
47 lines
1.4 KiB
Groff
47 lines
1.4 KiB
Groff
.TH libssh2_sftp_mkdir_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual"
|
|
.SH NAME
|
|
libssh2_sftp_mkdir_ex - create a directory on the remote file system
|
|
.SH SYNOPSIS
|
|
.nf
|
|
#include <libssh2.h>
|
|
#include <libssh2_sftp.h>
|
|
|
|
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);
|
|
.fi
|
|
.SH DESCRIPTION
|
|
\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
|
|
directory's parents must all exist prior 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).
|
|
|
|
Create a directory on the remote file system.
|
|
.SH RETURN VALUE
|
|
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_open_ex(3)
|