doc/crypto/ERR_put_error.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 ERR_put_error, ERR_add_error_data - record an error
   6
   7 =head1 SYNOPSIS
   8
   9  #include <openssl/err.h>
  10
  11  void ERR_put_error(int lib, int func, int reason, const char *file,
  12          int line);
  13
  14  void ERR_add_error_data(int num, ...);
  15
  16 =head1 DESCRIPTION
  17
  18 ERR_put_error() adds an error code to the thread's error queue. It
  19 signals that the error of reason code B<reason> occurred in function
  20 B<func> of library B<lib>, in line number B<line> of B<file>.
  21 This function is usually called by a macro.
  22
  23 ERR_add_error_data() associates the concatenation of its B<num> string
  24 arguments with the error code added last.
  25
  26 L<ERR_load_strings(3)|ERR_load_strings(3)> can be used to register
  27 error strings so that the application can a generate human-readable
  28 error messages for the error code.
  29
  30 =head1 RETURN VALUES
  31
  32 ERR_put_error() and ERR_add_error_data() return
  33 no values.
  34
  35 =head1 SEE ALSO
  36
  37 L<err(3)|err(3)>, L<ERR_load_strings(3)|ERR_load_strings(3)>
  38
  39 =head1 HISTORY
  40
  41 ERR_put_error() is available in all versions of SSLeay and OpenSSL.
  42 ERR_add_error_data() was added in SSLeay 0.9.0.
  43
  44 =cut