libssh2\_sftp\_close\_handle(3) libssh2 libssh2\_sftp\_close\_handle(3)

# [NAME](#NAME)

libssh2\_sftp\_close\_handle - close filehandle

# [SYNOPSIS](#SYNOPSIS)

```
#include <libssh2.h>
#include <libssh2_sftp.h>
int
libssh2_sftp_close_handle(LIBSSH2_SFTP_HANDLE *handle);
int
libssh2_sftp_close(LIBSSH2_SFTP_HANDLE *handle);
int
libssh2_sftp_closedir(LIBSSH2_SFTP_HANDLE *handle);
```

# [DESCRIPTION](#DESCRIPTION)

*handle* - SFTP File Handle as returned by [**libssh2\_sftp\_open\_ex(3)**](/man/os/libssh2/libssh2_sftp_open_ex.3) or [**libssh2\_sftp\_opendir(3)**](/man/os/libssh2/libssh2_sftp_opendir.3) (which is a macro).

Close an active LIBSSH2\_SFTP\_HANDLE. Because files and directories share the same underlying storage mechanism these methods may be used interchangeably. [**libssh2\_sftp\_close(3)**](/man/os/libssh2/libssh2_sftp_close.3) and [**libssh2\_sftp\_closedir(3)**](/man/os/libssh2/libssh2_sftp_closedir.3) are macros for [**libssh2\_sftp\_close\_handle(3)**](/man/os/libssh2/libssh2_sftp_close_handle.3).

# [RETURN VALUE](#RETURN_VALUE)

Return 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](#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](#SEE_ALSO)

[**libssh2\_sftp\_open\_ex(3)**](/man/os/libssh2/libssh2_sftp_open_ex.3)

1 Jun 2007 libssh2 0.15

---

Document: libssh2_sftp_close_handle(3) from libssh2 1.11.1-r10 (Chainguard OS)
Source: https://github.com/libssh2/libssh2.git
