diff options
Diffstat (limited to 'docs/ares_library_init.3')
| -rw-r--r-- | docs/ares_library_init.3 | 23 |
1 files changed, 13 insertions, 10 deletions
diff --git a/docs/ares_library_init.3 b/docs/ares_library_init.3 index b38cf32..2f61ce2 100644 --- a/docs/ares_library_init.3 +++ b/docs/ares_library_init.3 @@ -14,6 +14,8 @@ .\" this software for any purpose. It is provided "as is" .\" without express or implied warranty. .\" +.\" SPDX-License-Identifier: MIT +.\" .TH ARES_LIBRARY_INIT 3 "19 May 2009" .SH NAME ares_library_init \- c-ares library initialization @@ -79,23 +81,24 @@ DllMain function. Doing so will produce deadlocks and other problems. Initialize everything possible. This sets all known bits. .TP .B ARES_LIB_INIT_WIN32 -Initialize Win32/64 specific libraries. +Initialize Win32/64 specific libraries. As of c-ares 1.19.0, this is ignored +as there are no currently dynamically loaded libraries. .TP .B ARES_LIB_INIT_NONE Initialize nothing extra. This sets no bit. .SH RETURN VALUE -Upon successful completion, ares_library_init() will return 0. Otherwise, a -non-zero error number will be returned to indicate the error. Except for +Upon successful completion, \fIares_library_init(3)\fP returns 0. Otherwise, +a non-zero error number is returned to indicate the error. Except for \fIares_strerror(3)\fP, you shall not call any other c-ares function upon \fIares_library_init(3)\fP failure. .SH AVAILABILITY This function was first introduced in c-ares version 1.7.0 along with the definition of preprocessor symbol \fICARES_HAVE_ARES_LIBRARY_INIT\fP as an -indication of the availability of this function. Its recursive behavior, -which requires a matching number of calls to \fIares_library_cleanup()\fP -in order to deinitialize the library, is present since c-ares version -1.10.0. Earlier versions would deinitialize the library on the first call -to \fIares_library_cleanup()\fP. +indication of the availability of this function. Its recursive behavior, which +requires a matching number of calls to \fIares_library_cleanup(3)\fP in order +to deinitialize the library, is present since c-ares version 1.10.0. Earlier +versions would deinitialize the library on the first call to +\fIares_library_cleanup(3)\fP. .PP Since the introduction of this function it is absolutely mandatory to call it for any Win32/64 program using c-ares. @@ -104,8 +107,8 @@ Non-Win32/64 systems can still use c-ares version 1.7.0 without calling \fIares_library_init(3)\fP due to the fact that \fIcurrently\fP it is nearly a do-nothing function on non-Win32/64 platforms at this point. .SH SEE ALSO -.BR ares_library_cleanup(3), -.BR ares_strerror(3) +.BR ares_library_cleanup (3), +.BR ares_strerror (3) .SH AUTHOR Yang Tse .PP |