libssh2\_session\_disconnect\_ex(3) libssh2 libssh2\_session\_disconnect\_ex(3)

# [NAME](#NAME)

libssh2\_session\_disconnect\_ex - terminate transport layer

# [SYNOPSIS](#SYNOPSIS)

```
#include <libssh2.h>
int
libssh2_session_disconnect_ex(LIBSSH2_SESSION *session, int reason,


                              const char *description,


                              const char *lang);
int
libssh2_session_disconnect(LIBSSH2_SESSION *session,


                           const char *description);
```

# [DESCRIPTION](#DESCRIPTION)

*session* - Session instance as returned by [**libssh2\_session\_init\_ex(3)**](/man/os/libssh2/libssh2_session_init_ex.3)

*reason* - One of the Disconnect Reason constants.

*description* - Human readable reason for disconnection.

*lang* - Localization string describing the language/encoding of the description provided.

Send a disconnect message to the remote host associated with *session*, along with a *reason* symbol and a verbose *description*.

As a convenience, the macro [**libssh2\_session\_disconnect(3)**](/man/os/libssh2/libssh2_session_disconnect.3) is provided. It calls [**libssh2\_session\_disconnect\_ex(3)**](/man/os/libssh2/libssh2_session_disconnect_ex.3) with *reason* set to SSH\_DISCONNECT\_BY\_APPLICATION and *lang* set to an empty string.

# [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.

# [SEE ALSO](#SEE_ALSO)

[**libssh2\_session\_init\_ex(3)**](/man/os/libssh2/libssh2_session_init_ex.3)

1 Jun 2007 libssh2 0.15

---

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