diff options
Diffstat (limited to 'src/lib/libcrypto/doc/ERR_remove_state.pod')
| -rw-r--r-- | src/lib/libcrypto/doc/ERR_remove_state.pod | 34 |
1 files changed, 34 insertions, 0 deletions
diff --git a/src/lib/libcrypto/doc/ERR_remove_state.pod b/src/lib/libcrypto/doc/ERR_remove_state.pod new file mode 100644 index 0000000000..72925fb9f4 --- /dev/null +++ b/src/lib/libcrypto/doc/ERR_remove_state.pod | |||
| @@ -0,0 +1,34 @@ | |||
| 1 | =pod | ||
| 2 | |||
| 3 | =head1 NAME | ||
| 4 | |||
| 5 | ERR_remove_state - free a thread's error queue | ||
| 6 | |||
| 7 | =head1 SYNOPSIS | ||
| 8 | |||
| 9 | #include <openssl/err.h> | ||
| 10 | |||
| 11 | void ERR_remove_state(unsigned long pid); | ||
| 12 | |||
| 13 | =head1 DESCRIPTION | ||
| 14 | |||
| 15 | ERR_remove_state() frees the error queue associated with thread B<pid>. | ||
| 16 | If B<pid> == 0, the current thread will have its error queue removed. | ||
| 17 | |||
| 18 | Since error queue data structures are allocated automatically for new | ||
| 19 | threads, they must be freed when threads are terminated in order to | ||
| 20 | avoid memory leaks. | ||
| 21 | |||
| 22 | =head1 RETURN VALUE | ||
| 23 | |||
| 24 | ERR_remove_state() returns no value. | ||
| 25 | |||
| 26 | =head1 SEE ALSO | ||
| 27 | |||
| 28 | L<err(3)|err(3)> | ||
| 29 | |||
| 30 | =head1 HISTORY | ||
| 31 | |||
| 32 | ERR_remove_state() is available in all versions of SSLeay and OpenSSL. | ||
| 33 | |||
| 34 | =cut | ||
