1
0
mirror of https://github.com/libssh2/libssh2.git synced 2026-10-24 03:48:58 +03:00
Files
libssh2/docs/libssh2_session_free.md
Viktor Szakats 99803822cb tidy-up: miscellaneous
- fix typos in comments and documentation.
- fix references to non-existing functions in comments.
- libssh2_session_free: fix see-also reference on man page.
- libssh2_scp_recv2: fix typo in prototype on man page.
- man2help: use increment operator.
- badwords: extend with new words and an exclusion.
- userauth: unfold string.
- clang-format and manual formatting.

Closes #1988
2026-06-05 18:12:37 +02:00

788 B

c, SPDX-License-Identifier, Title, Section, Source, See-also
c SPDX-License-Identifier Title Section Source See-also
Copyright (C) The libssh2 project and its contributors. BSD-3-Clause libssh2_session_free 3 libssh2
libssh2_session_disconnect(3)
libssh2_session_disconnect_ex(3)
libssh2_session_init_ex(3)

NAME

libssh2_session_free - frees resources associated with a session instance

SYNOPSIS

#include <libssh2.h>

int libssh2_session_free(LIBSSH2_SESSION *session);

DESCRIPTION

Frees all resources associated with a session instance. Typically called after libssh2_session_disconnect_ex(3).

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.