update docs because depth refers only to intermediate certs
[openssl.git] / doc / man3 / 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  void ERR_load_crypto_strings(void);
16  void ERR_free_strings(void);
17  #endif
18
19  #include <openssl/ssl.h>
20
21  #if OPENSSL_API_COMPAT < 0x10100000L
22  void SSL_load_error_strings(void);
23  #endif
24
25 =head1 DESCRIPTION
26
27 All of the following functions are deprecated from OpenSSL 1.1.0. No explicit
28 initialisation or de-initialisation is necessary. See L<OPENSSL_init_crypto(3)>
29 and L<OPENSSL_init_ssl(3)>.
30
31 ERR_load_crypto_strings() registers the error strings for all
32 B<libcrypto> functions. SSL_load_error_strings() does the same,
33 but also registers the B<libssl> error strings.
34
35 In versions of OpenSSL prior to 1.1.0 ERR_free_strings() freed all previously
36 loaded error strings. However from OpenSSL 1.1.0 it does nothing.
37
38 =head1 RETURN VALUES
39
40 ERR_load_crypto_strings(), SSL_load_error_strings() and
41 ERR_free_strings() return no values.
42
43 =head1 SEE ALSO
44
45 L<ERR_error_string(3)>
46
47 =head1 HISTORY
48
49 The ERR_load_crypto_strings(), SSL_load_error_strings(), and
50 ERR_free_strings() functions were deprecated in OpenSSL 1.1.0 by
51 OPENSSL_init_crypto() and OPENSSL_init_ssl().
52
53 =head1 COPYRIGHT
54
55 Copyright 2000-2017 The OpenSSL Project Authors. All Rights Reserved.
56
57 Licensed under the OpenSSL license (the "License").  You may not use
58 this file except in compliance with the License.  You can obtain a copy
59 in the file LICENSE in the source distribution or at
60 L<https://www.openssl.org/source/license.html>.
61
62 =cut