doc/crypto/ERR_load_crypto_strings.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 ERR_load_crypto_strings, SSL_load_error_strings, ERR_free_strings -
   6 load and free error strings
   7
   8 =head1 SYNOPSIS
   9
  10 Deprecated:
  11
  12  #include <openssl/err.h>
  13
  14  #if OPENSSL_API_COMPAT < 0x10100000L
  15  # define ERR_load_crypto_strings() \
  16      OPENSSL_init_crypto(OPENSSL_INIT_LOAD_CRYPTO_STRINGS, NULL)
  17  # define ERR_free_strings()
  18  #endif
  19
  20  #include <openssl/ssl.h>
  21
  22  #if OPENSSL_API_COMPAT < 0x10100000L
  23  # define SSL_load_error_strings() \
  24      OPENSSL_init_ssl(OPENSSL_INIT_LOAD_SSL_STRINGS \
  25                      | OPENSSL_INIT_LOAD_CRYPTO_STRINGS, NULL)
  26  #endif
  27
  28 =head1 DESCRIPTION
  29
  30 All of the following functions are deprecated from OpenSSL 1.1.0. No explicit
  31 initialisation or de-initialisation is necessary. See L<OPENSSL_init_crypto(3)>
  32 and L<OPENSSL_init_ssl(3)>.
  33
  34 ERR_load_crypto_strings() registers the error strings for all
  35 B<libcrypto> functions. SSL_load_error_strings() does the same,
  36 but also registers the B<libssl> error strings.
  37
  38 In versions of OpenSSL prior to 1.1.0 ERR_free_strings() freed all previously
  39 loaded error strings. However from OpenSSL 1.1.0 it does nothing.
  40
  41 =head1 RETURN VALUES
  42
  43 ERR_load_crypto_strings(), SSL_load_error_strings() and
  44 ERR_free_strings() return no values.
  45
  46 =head1 SEE ALSO
  47
  48 L<err(3)>, L<ERR_error_string(3)>
  49
  50 =head1 HISTORY
  51
  52 The ERR_load_crypto_strings(), SSL_load_error_strings(), and
  53 ERR_free_strings() functions were deprecated in OpenSSL 1.1.0 by
  54 OPENSSL_init_crypto() and OPENSSL_init_ssl().
  55
  56 =cut