Convert ERR_STATE to new multi-threading API
[openssl.git] / doc / crypto / ERR_remove_state.pod
1 =pod
2
3 =head1 NAME
4
5 ERR_remove_thread_state, ERR_remove_state - free a thread's error queue
6
7 =head1 SYNOPSIS
8
9  #include <openssl/err.h>
10
11  void ERR_remove_thread_state(void);
12
13 Deprecated:
14
15  #if OPENSSL_API_COMPAT < 0x10000000L
16  void ERR_remove_state(unsigned long pid);
17  #endif
18
19 =head1 DESCRIPTION
20
21 ERR_remove_thread_state() frees the error queue associated with the current
22 thread.
23
24 Since error queue data structures are allocated automatically for new
25 threads, they must be freed when threads are terminated in order to
26 avoid memory leaks.
27
28 ERR_remove_state is deprecated and has been replaced by
29 ERR_remove_thread_state. Any argument to this function is ignored and
30 calling ERR_remove_state is equivalent to B<ERR_remove_thread_state()>.
31
32 =head1 RETURN VALUE
33
34 ERR_remove_thread_state and ERR_remove_state() return no value.
35
36 =head1 SEE ALSO
37
38 L<err(3)>
39
40 =head1 HISTORY
41
42 ERR_remove_state()
43 was deprecated in OpenSSL 1.0.0 when ERR_remove_thread_state() was introduced.
44
45 =cut