From 94a2585e9ecc41176072294d5bf751c17ad66869 Mon Sep 17 00:00:00 2001 From: James Housley Date: Wed, 13 Jun 2007 15:45:18 +0000 Subject: [PATCH] Update to match current code and add errors --- docs/libssh2_sftp_readdir.3 | 41 ++++++++++++++++++++++++------------- 1 file changed, 27 insertions(+), 14 deletions(-) diff --git a/docs/libssh2_sftp_readdir.3 b/docs/libssh2_sftp_readdir.3 index 565e943..5427563 100644 --- a/docs/libssh2_sftp_readdir.3 +++ b/docs/libssh2_sftp_readdir.3 @@ -1,37 +1,50 @@ -.\" $Id: libssh2_sftp_readdir.3,v 1.6 2007/06/13 12:51:11 jehousley Exp $ +.\" $Id: libssh2_sftp_readdir.3,v 1.7 2007/06/13 15:45:18 jehousley Exp $ .\" -.TH libssh2_sftp_readdir 3 "16 Apr 2007" "libssh2 0.15" "libssh2 manual" +.TH libssh2_sftp_readdir 3 "1 June 2007" "libssh2 0.15" "libssh2 manual" .SH NAME libssh2_sftp_readdir - read directory data from an SFTP handle .SH SYNOPSIS #include #include -int libssh2_sftp_readdir(LIBSSH2_SFTP_HANDLE *handle, char *buffer, - size_t buffer_maxlen, LIBSSH2_SFTP_ATTRIBUTES *attrs); +int +libssh2_sftp_readdir(LIBSSH2_SFTP_HANDLE *handle, char *buffer, size_t buffer_maxlen, LIBSSH2_SFTP_ATTRIBUTES *attrs); .SH DESCRIPTION -Read a block of data from a LIBSSH2_SFTP_HANDLE. This method is modeled -after the POSIX \fIreaddir(3)\fP however, it uses a variable sized directory -entry (filename) buffer and returns statbuf type data in the same call. +\fIhandle\fP - is the SFTP File Handle as returned by +.BR libssh2_sftp_diropen(3) -\fIhandle\fP is the SFTP File Handle as returned by -\fIlibssh2_sftp_diropen(3)\fP. - -\fIbuffer\fP is a pointer to a pre-allocated buffer of at least +\fIbuffer\fP - is a pointer to a pre-allocated buffer of at least \fIbuffer_maxlen\fP bytes to read data into. -\fIbuffer_maxlen\fP is the length of buffer in bytes. If the length of the +\fIbuffer_maxlen\fP - is the length of buffer in bytes. If the length of the filename is longer than the space provided by buffer_maxlen it will be truncated to fit. -\fIattrs\fP is a pointer to LIBSSH2_SFTP_ATTRIBUTES storage to populate +\fIattrs\fP - is a pointer to LIBSSH2_SFTP_ATTRIBUTES storage to populate statbuf style data into. +Read a block of data from a LIBSSH2_SFTP_HANDLE. This method is modeled +after the POSIX +.BR readdir(2) +however, it uses a variable sized directory entry (filename) buffer and +returns statbuf type data in the same call. + .SH RETURN VALUE Number of bytes actually populated into buffer, 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 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) -.BR libssh2_sftp_readdirnb(3) +.BR libssh2_sftp_closedir(3)