libssh: The SSH error functions

libssh 0.11.2 The SSH library

Loading...
Searching...
No Matches
The SSH error functions
The libssh API

## Functions
void | _ssh_set_error (void *error, int code, const char *function, const char *descr,...)
void | _ssh_set_error_oom (void *error, const char *function)
void | _ssh_set_error_invalid (void *error, const char *function)
void | ssh_reset_error (void *error)
const char * | ssh_get_error (void *error)
| Retrieve the error text message from the last error.
int | ssh_get_error_code (void *error)
| Retrieve the error code from the last error.

## Detailed Description

Functions for error handling.

## Function Documentation

## ◆ ssh_get_error()

const char * ssh_get_error | ( | void * | error | ) |

Retrieve the error text message from the last error.

Parameters

  error | An ssh_session or ssh_bind.

Returns
  A static string describing the error.

## ◆ ssh_get_error_code()

int ssh_get_error_code | ( | void * | error | ) |

Retrieve the error code from the last error.

Parameters

  error | An ssh_session or ssh_bind.

Returns
  SSH_NO_ERROR No error occurred
  SSH_REQUEST_DENIED The last request was denied but situation is recoverable
  SSH_FATAL A fatal error occurred. This could be an unexpected disconnection
  Other error codes are internal but can be considered the same as SSH_FATAL.