libssh2_sftp_readdir_ex(3) libssh2 manual libssh2_sftp_readdir_ex(3)NAMElibssh2_sftp_readdir_ex - read directory data from an SFTP handle
#include <libssh2.h> #include <libssh2_sftp.h>
int libssh2_sftp_readdir_ex(LIBSSH2_SFTP_HANDLE *handle, char *buffer,
size_t buffer_maxlen, char *longentry, size_t longentry_maxlen, LIB‐
int libssh2_sftp_readdir(LIBSSH2_SFTP_HANDLE *handle, char *buffer,
size_t buffer_maxlen, LIBSSH2_SFTP_ATTRIBUTES *attrs);
handle - is the SFTP File Handle as returned by libssh2_sftp_open_ex(3)
buffer - is a pointer to a pre-allocated buffer of at least buf‐
fer_maxlen bytes to read data into.
buffer_maxlen - 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.
longentry - is a pointer to a pre-allocated buffer of at least longen‐
try_maxlen bytes to read data into.
longentry_maxlen - is the length of longentry in bytes. If the length
of the full directory entry is longer than the space provided by lon‐
gentry_maxlen it will be truncated to fit.
attrs - 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 readdir(2) however, it uses a variable sized directory
entry (filename) buffer and returns statbuf type data in the same call.
Number of bytes actually populated into buffer, or negative 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
LIBSSH2_ERROR_ALLOC - An internal memory allocation call failed.
LIBSSH2_ERROR_SOCKET_SEND - Unable to send data on socket.
LIBSSH2_ERROR_SFTP_PROTOCOL - An invalid SFTP protocol response was
received on the socket, or an SFTP operation caused an errorcode to be
returned by the server.
SEE ALSOlibssh2_sftp_open_ex(3), libssh2_sftp_close_handle(3)libssh2 0.15 1 Jun 2007 libssh2_sftp_readdir_ex(3)