---
name: "libssh2_sftp_stat_ex"
section: "3"
platform: "linux"
package: "libssh2"
version: "1.11.1-7"
release: "Arch Linux 2026-11-01"
platforms: ["linux"]
url: "https://new.carta.tech/libssh2_sftp_stat_ex"
---

# libssh2\_sftp\_stat\_ex(3)

get status about an SFTP file

## NAME

libssh2\_sftp\_stat\_ex - get status about an SFTP file

## SYNOPSIS

```
#include <libssh2.h>
#include <libssh2_sftp.h>
int
libssh2_sftp_stat_ex(LIBSSH2_SFTP *sftp, const char *path,
                     unsigned int path_len, int stat_type,
                     LIBSSH2_SFTP_ATTRIBUTES *attrs);
```

## DESCRIPTION

*sftp* - SFTP instance as returned by **[libssh2\_sftp\_init(3)](/libssh2_sftp_init/3.md)**

*path* - Remote filesystem object to stat/lstat/setstat.

*path\_len* - Length of the name of the remote filesystem object to stat/lstat/setstat.

*stat\_type* - One of the three constants specifying the type of stat operation to perform:

**LIBSSH2\_SFTP\_STAT**: performs [stat(2)](/stat/2.md) operation\
 **LIBSSH2\_SFTP\_LSTAT**: performs [lstat(2)](/lstat/2.md) operation\
 **LIBSSH2\_SFTP\_SETSTAT**: performs operation to set stat info on file

*attrs* - Pointer to a **LIBSSH2\_SFTP\_ATTRIBUTES** structure to set file metadata from or into depending on the value of stat\_type.

Get or Set statbuf type data on a remote filesystem object. When getting statbuf data, **[libssh2\_sftp\_stat(3)](/libssh2_sftp_stat/3.md)** will follow all symlinks, while **[libssh2\_sftp\_lstat(3)](/libssh2_sftp_lstat/3.md)** will return data about the object encountered, even if that object happens to be a symlink.

The LIBSSH2\_SFTP\_ATTRIBUTES struct looks like this:

```
struct LIBSSH2_SFTP_ATTRIBUTES {
    /* If flags & ATTR_* bit is set, then the value in this struct will be
     * meaningful Otherwise it should be ignored
     */
    unsigned long flags;
    libssh2_uint64_t filesize;
    unsigned long uid;
    unsigned long gid;
    unsigned long permissions;
    unsigned long atime;
    unsigned long mtime;
};
```

## RETURN VALUE

Returns 0 on success or negative on failure. It returns LIBSSH2\_ERROR\_EAGAIN when it would otherwise block. While LIBSSH2\_ERROR\_EAGAIN is a negative number, it is not really a failure per se.

## ERRORS

*LIBSSH2\_ERROR\_ALLOC* - An internal memory allocation call failed.

*LIBSSH2\_ERROR\_SOCKET\_SEND* - Unable to send data on socket.

*LIBSSH2\_ERROR\_SOCKET\_TIMEOUT* -

*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 ALSO

**[libssh2\_sftp\_init(3)](/libssh2_sftp_init/3.md)**