Index for Section 3

Alphabetical listing for E

Bottom of page

ERR_get_error(3)
NAME
  ERR_get_error, ERR_peek_error, ERR_get_error_line, ERR_peek_error_line,
  ERR_get_error_line_data, ERR_peek_error_line_data - Obtain error code and
  data

SYNOPSIS
  #include <openssl/err.h>

  unsigned long ERR_get_error(
	  void );

  unsigned long ERR_peek_error(
	  void );

  unsigned long ERR_get_error_line(
	  unsigned long const char **file, int *line );

  unsigned long ERR_peek_error_line(
	  const char **file, int *line );

  unsigned long ERR_get_error_line_data(
	  const char **file, int *line, const char **data, int *flags );

  unsigned long ERR_peek_error_line_data(
	  const char **file, int *line, const char **data, int *flags );

DESCRIPTION
  The ERR_get_error() function returns the last error code from the thread's
  error queue and removes the entry. This function can be called repeatedly
  until there are no more error codes to return.

  The ERR_peek_error() function returns the last error code from the thread's
  error queue without modifying it.

  See ERR_GET_LIB(3) for information about location and reason of the error,
  and ERR_error_string(3) for human-readable error messages.

  The ERR_get_error_line() and ERR_peek_error_line() functions are the same
  as the above, but they also store the file name and line number where the
  error occurred in *file and *line, unless these are NULL.

  The ERR_get_error_line_data() and ERR_peek_error_line_data() functions
  store additional data and flags associated with the error code in *data and
  *flags, unless these are NULL. The *data contains a string if
  *flags&ERR_TXT_STRING.  If it has been allocated by OPENSSL_malloc(),
  *flags&ERR_TXT_MALLOCED is true.

RETURN VALUES
  The error code, or 0 if there is no error in the queue.

HISTORY
  The ERR_get_error(), ERR_peek_error(), ERR_get_error_line(), and
  ERR_peek_error_line() functions are available in all versions of SSLeay and
  OpenSSL. The ERR_get_error_line_data() and ERR_peek_error_line_data()
  functions were added in SSLeay 0.9.0.

SEE ALSO
  Functions: err(3), ERR_error_string(3), ERR_GET_LIB(3)

Index for Section 3

Alphabetical listing for E

Top of page