Slightly reformat ssl.h.in
[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 since OpenSSL 1.1.0, can be hidden entirely by defining
11 B<OPENSSL_API_COMPAT> with a suitable version value, see
12 L<openssl_user_macros(7)>:
13
14  #include <openssl/err.h>
15
16  void ERR_load_crypto_strings(void);
17  void ERR_free_strings(void);
18
19  #include <openssl/ssl.h>
20
21  void SSL_load_error_strings(void);
22
23 =head1 DESCRIPTION
24
25 ERR_load_crypto_strings() registers the error strings for all
26 B<libcrypto> functions. SSL_load_error_strings() does the same,
27 but also registers the B<libssl> error strings.
28
29 In versions prior to OpenSSL 1.1.0,
30 ERR_free_strings() releases any resources created by the above functions.
31
32 =head1 RETURN VALUES
33
34 ERR_load_crypto_strings(), SSL_load_error_strings() and
35 ERR_free_strings() return no values.
36
37 =head1 SEE ALSO
38
39 L<ERR_error_string(3)>
40
41 =head1 HISTORY
42
43 The ERR_load_crypto_strings(), SSL_load_error_strings(), and
44 ERR_free_strings() functions were deprecated in OpenSSL 1.1.0 by
45 OPENSSL_init_crypto() and OPENSSL_init_ssl() and should not be used.
46
47 =head1 COPYRIGHT
48
49 Copyright 2000-2017 The OpenSSL Project Authors. All Rights Reserved.
50
51 Licensed under the Apache License 2.0 (the "License").  You may not use
52 this file except in compliance with the License.  You can obtain a copy
53 in the file LICENSE in the source distribution or at
54 L<https://www.openssl.org/source/license.html>.
55
56 =cut