ERR_put_error.pod 1.1 KB

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