libssh2

1
.\" Copyright (C) The libssh2 project and its contributors.
2
.\" SPDX-License-Identifier: BSD-3-Clause
3
.TH libssh2_sftp_readdir 3 "20 Feb 2010" "libssh2 1.2.4" "libssh2"
4
.SH NAME
5
libssh2_sftp_readdir - convenience macro for \fIlibssh2_sftp_readdir_ex(3)\fP calls
6
.SH SYNOPSIS
7
.nf
8
#include <libssh2.h>
9
#include <libssh2_sftp.h>
10

11
int
12
libssh2_sftp_readdir(LIBSSH2_SFTP_HANDLE *handle,
13
                     char *buffer, size_t buffer_maxlen,
14
                     LIBSSH2_SFTP_ATTRIBUTES *attrs);
15
.fi
16
.SH DESCRIPTION
17
This is a macro defined in a public libssh2 header file that is using the
18
underlying function \fIlibssh2_sftp_readdir_ex(3)\fP.
19
.SH RETURN VALUE
20
See \fIlibssh2_sftp_readdir_ex(3)\fP
21
.SH ERRORS
22
See \fIlibssh2_sftp_readdir_ex(3)\fP
23
.SH SEE ALSO
24
.BR libssh2_sftp_readdir_ex(3)
25