1
0
mirror of https://github.com/libssh2/libssh2.git synced 2026-10-24 03:48:58 +03:00
Files
libssh2/docs/libssh2_session_set_last_error.md
Viktor Szakats 9538c99fc4 badwords: add checker script, fix issues found
Checker script and wordlist comes from curl.

Also:
- checksrc.pl: sync up with curl.
- unfold an IETF URL.
- update all IETF URLs where missing.

Closes #1959
2026-06-01 13:22:40 +02:00

1.1 KiB

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_set_last_error 3 libssh2
libssh2_session_init_ex(3)
libssh2_session_last_errno(3)
libssh2_session_last_error(3)

NAME

libssh2_session_set_last_error - sets the internal error state

SYNOPSIS

#include <libssh2.h>

int
libssh2_session_set_last_error(LIBSSH2_SESSION *session,
                               int errcode, const char *errmsg)

DESCRIPTION

session - Session instance as returned by libssh2_session_init_ex(3)

errcode - One of the error codes as defined in the public libssh2 header file.

errmsg - If not NULL, a copy of the given string is stored inside the session object as the error message.

This function is provided for high level language wrappers (i.e. Python or Perl) and other libraries that may extend libssh2 with additional features while still relying on its error reporting mechanism.

RETURN VALUE

Numeric error code corresponding to the Error Code constants.

AVAILABILITY

Added in 1.6.1