lib/libssh2
1
0
Fork 0
mirror of https://github.com/libssh2/libssh2.git synced 2025-10-24 14:53:03 +03:00
Code Activity
Files
3969991b683efac1d40d76a42af3a47832b85783
libssh2/docs/libssh2_session_last_error.md
Viktor Szakats b889b39945 docs: convert man page sources to "curldown" format 
To render in Git webviews as-is, to make it easier to edit, verify,
and to sync up with curl.

- add options to not build the `.3` man pages:
  - autotools: `--disable-docs`
  - cmake: `LIBSSH2_BUILD_DOCS=OFF`
- building `.3` man pages requires Perl after this patch.
- drop `mansyntax` and the shell / `grep` / GNU `man` tool requirements with it.
- scripts and most logic were copied from curl.
- add `cd2nroff` from curl, with edits to relax curl-specific checks.
- used `nroff2cd` (from curl) to convert from `.3` to `.md`. Then
  manually fixed copyrights, inline function references and a couple
  of other things.

Credits-to: Daniel Stenberg

Ref: eefcc1bda4
Ref: https://github.com/curl/curl/pull/12730
Ref: https://github.com/libssh2/www/issues/25#issuecomment-3289431671

Closes #1660
2025-10-09 04:05:38 +02:00

1.2 KiB
Raw Blame History

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_last_error 3 libssh2
libssh2_session_init_ex(3)
libssh2_session_last_errno(3)
libssh2_session_set_last_error(3)

NAME

libssh2_session_last_error - get the most recent error

SYNOPSIS

#include <libssh2.h>

int
libssh2_session_last_error(LIBSSH2_SESSION *session,
                           char **errmsg, int *errmsg_len, int want_buf);

DESCRIPTION

session - Session instance as returned by libssh2_session_init_ex(3)

errmsg - If not NULL, is populated by reference with the human readable form of the most recent error message.

errmsg_len - If not NULL, is populated by reference with the length of errmsg. (The string is NUL-terminated, so the length is only useful as an optimization, to avoid calling strlen.)

want_buf - If set to a non-zero value, "ownership" of the errmsg buffer will be given to the calling scope. If necessary, the errmsg buffer will be duplicated.

Determine the most recent error condition and its cause.

RETURN VALUE

Numeric error code corresponding to the the Error Code constants.