openssl/doc/crypto/ERR_remove_state.pod

48 lines
1.2 KiB
Plaintext
Raw Normal View History

2000-02-01 09:37:00 +08:00
=pod
=head1 NAME
ERR_remove_thread_state, ERR_remove_state - free a thread's error queue
2000-02-01 09:37:00 +08:00
=head1 SYNOPSIS
#include <openssl/err.h>
void ERR_remove_thread_state(const CRYPTO_THREADID *tid);
Deprecated:
#if OPENSSL_API_COMPAT < 0x10000000L
2000-02-01 09:37:00 +08:00
void ERR_remove_state(unsigned long pid);
#endif
2000-02-01 09:37:00 +08:00
=head1 DESCRIPTION
ERR_remove_thread_state() frees the error queue associated with thread B<tid>.
If B<tid> == B<NULL>, the current thread will have its error queue removed.
2000-02-01 09:37:00 +08:00
Since error queue data structures are allocated automatically for new
2000-05-19 15:54:42 +08:00
threads, they must be freed when threads are terminated in order to
2000-02-01 09:37:00 +08:00
avoid memory leaks.
ERR_remove_state is deprecated and has been replaced by
ERR_remove_thread_state. Since threads in OpenSSL are no longer identified
by unsigned long values any argument to this function is ignored. Calling
ERR_remove_state is equivalent to B<ERR_remove_thread_state(NULL)>.
2000-02-01 09:37:00 +08:00
=head1 RETURN VALUE
ERR_remove_thread_state and ERR_remove_state() return no value.
2000-02-01 09:37:00 +08:00
=head1 SEE ALSO
L<err(3)>
2000-02-01 09:37:00 +08:00
=head1 HISTORY
ERR_remove_state()
was deprecated in OpenSSL 1.0.0 when ERR_remove_thread_state() was introduced
and thread IDs were introduced to identify threads instead of 'unsigned long'.
2000-02-01 09:37:00 +08:00
=cut