mirror of
https://github.com/openssl/openssl.git
synced 2024-12-21 06:09:35 +08:00
3dbf824380
There was recently an instance where a user was confused by the deprecation warnings in the docs. They believed the warning applied to the immediately preceding function declarations, when it fact it applied to the following function declarations. https://mta.openssl.org/pipermail/openssl-users/2021-December/014665.html We clarify the wording to make it clear that the warning applies to the following functions. Reviewed-by: Paul Dale <pauli@openssl.org> Reviewed-by: Tomas Mraz <tomas@openssl.org> Reviewed-by: Richard Levitte <levitte@openssl.org> (Merged from https://github.com/openssl/openssl/pull/17180)
57 lines
1.5 KiB
Plaintext
57 lines
1.5 KiB
Plaintext
=pod
|
|
|
|
=head1 NAME
|
|
|
|
ERR_load_crypto_strings, SSL_load_error_strings, ERR_free_strings -
|
|
load and free error strings
|
|
|
|
=head1 SYNOPSIS
|
|
|
|
The following functions have been deprecated since OpenSSL 1.1.0, and can be
|
|
hidden entirely by defining B<OPENSSL_API_COMPAT> with a suitable version value,
|
|
see L<openssl_user_macros(7)>:
|
|
|
|
#include <openssl/err.h>
|
|
|
|
void ERR_load_crypto_strings(void);
|
|
void ERR_free_strings(void);
|
|
|
|
#include <openssl/ssl.h>
|
|
|
|
void SSL_load_error_strings(void);
|
|
|
|
=head1 DESCRIPTION
|
|
|
|
ERR_load_crypto_strings() registers the error strings for all
|
|
B<libcrypto> functions. SSL_load_error_strings() does the same,
|
|
but also registers the B<libssl> error strings.
|
|
|
|
In versions prior to OpenSSL 1.1.0,
|
|
ERR_free_strings() releases any resources created by the above functions.
|
|
|
|
=head1 RETURN VALUES
|
|
|
|
ERR_load_crypto_strings(), SSL_load_error_strings() and
|
|
ERR_free_strings() return no values.
|
|
|
|
=head1 SEE ALSO
|
|
|
|
L<ERR_error_string(3)>
|
|
|
|
=head1 HISTORY
|
|
|
|
The ERR_load_crypto_strings(), SSL_load_error_strings(), and
|
|
ERR_free_strings() functions were deprecated in OpenSSL 1.1.0 by
|
|
OPENSSL_init_crypto() and OPENSSL_init_ssl() and should not be used.
|
|
|
|
=head1 COPYRIGHT
|
|
|
|
Copyright 2000-2017 The OpenSSL Project Authors. All Rights Reserved.
|
|
|
|
Licensed under the Apache License 2.0 (the "License"). You may not use
|
|
this file except in compliance with the License. You can obtain a copy
|
|
in the file LICENSE in the source distribution or at
|
|
L<https://www.openssl.org/source/license.html>.
|
|
|
|
=cut
|