Restore the ERR_remove_thread_state() API and make it a no-op
[oweals/openssl.git] / doc / crypto / ERR_remove_state.pod
1 =pod
2
3 =head1 NAME
4
5 ERR_remove_thread_state, ERR_remove_state - DEPRECATED
6
7 =head1 SYNOPSIS
8
9 Deprecated:
10
11  #if OPENSSL_API_COMPAT < 0x10000000L
12  void ERR_remove_state(unsigned long pid);
13  #endif
14
15  #if OPENSSL_API_COMPAT < 0x10100000L
16  void ERR_remove_thread_state(void *);
17  #endif
18
19 =head1 DESCRIPTION
20
21 The functions described here were used to free the error queue
22 associated with the current or specificed thread.
23
24 They are now deprecated and do nothing, please use
25 OPENSSL_thread_stop() instead.
26
27 =head1 RETURN VALUE
28
29 The functions described here return no value.
30
31 =head1 SEE ALSO
32
33 L<err(3)>, L<OPENSSL_thread_stop(3)>
34
35 =head1 HISTORY
36
37 ERR_remove_state() was deprecated in OpenSSL 1.0.0 when
38 ERR_remove_thread_state() was introduced.
39
40 ERR_remove_thread_state() was deprecated in OpenSSL 1.1.0 when the
41 thread handling functionality was entirely rewritten.
42
43 =cut