---
c: Copyright (C) The libssh2 project and its contributors.
SPDX-License-Identifier: BSD-3-Clause
Title: libssh2_sftp_readdir
Section: 3
Source: libssh2
See-also:
  - libssh2_sftp_readdir_ex(3)
---

# NAME

libssh2_sftp_readdir - convenience macro for *libssh2_sftp_readdir_ex(3)* calls

# SYNOPSIS

~~~c
#include <libssh2.h>
#include <libssh2_sftp.h>

int
libssh2_sftp_readdir(LIBSSH2_SFTP_HANDLE *handle,
                     char *buffer, size_t buffer_maxlen,
                     LIBSSH2_SFTP_ATTRIBUTES *attrs);
~~~

# DESCRIPTION

This is a macro defined in a public libssh2 header file that is using the
underlying function *libssh2_sftp_readdir_ex(3)*.

# RETURN VALUE

See *libssh2_sftp_readdir_ex(3)*

# ERRORS

See *libssh2_sftp_readdir_ex(3)*