ERR_load_strings.pod 1.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354
  1. =pod
  2. =head1 NAME
  3. ERR_load_strings, ERR_PACK, ERR_get_next_error_library - load
  4. arbitrary error strings
  5. =head1 SYNOPSIS
  6. #include <openssl/err.h>
  7. void ERR_load_strings(int lib, ERR_STRING_DATA str[]);
  8. int ERR_get_next_error_library(void);
  9. unsigned long ERR_PACK(int lib, int func, int reason);
  10. =head1 DESCRIPTION
  11. ERR_load_strings() registers error strings for library number B<lib>.
  12. B<str> is an array of error string data:
  13. typedef struct ERR_string_data_st
  14. {
  15. unsigned long error;
  16. char *string;
  17. } ERR_STRING_DATA;
  18. The error code is generated from the library number and a function and
  19. reason code: B<error> = ERR_PACK(B<lib>, B<func>, B<reason>).
  20. ERR_PACK() is a macro.
  21. The last entry in the array is {0,0}.
  22. ERR_get_next_error_library() can be used to assign library numbers
  23. to user libraries at runtime.
  24. =head1 RETURN VALUE
  25. ERR_load_strings() returns no value. ERR_PACK() return the error code.
  26. ERR_get_next_error_library() returns a new library number.
  27. =head1 SEE ALSO
  28. L<err(3)|err(3)>, L<ERR_load_strings(3)|ERR_load_strings(3)>
  29. =head1 HISTORY
  30. ERR_load_error_strings() and ERR_PACK() are available in all versions
  31. of SSLeay and OpenSSL. ERR_get_next_error_library() was added in
  32. SSLeay 0.9.0.
  33. =cut