ERR_load_strings.pod 1.4 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758
  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 run time.
  24. =head1 RETURN VALUES
  25. ERR_load_strings() returns no value. ERR_PACK() return the error code.
  26. ERR_get_next_error_library() returns zero on failure, otherwise a new
  27. library number.
  28. =head1 SEE ALSO
  29. L<ERR_load_strings(3)>
  30. =head1 COPYRIGHT
  31. Copyright 2000-2018 The OpenSSL Project Authors. All Rights Reserved.
  32. Licensed under the Apache License 2.0 (the "License"). You may not use
  33. this file except in compliance with the License. You can obtain a copy
  34. in the file LICENSE in the source distribution or at
  35. L<https://www.openssl.org/source/license.html>.
  36. =cut