Support Watt-32 under Win32.
[platform/upstream/c-ares.git] / ares_gethostbyname.3
index 9f5b07e..c59c038 100644 (file)
@@ -22,7 +22,7 @@ ares_gethostbyname \- Initiate a host query by name
 .B #include <ares.h>
 .PP
 .B typedef void (*ares_host_callback)(void *\fIarg\fP, int \fIstatus\fP,
-.B     struct hostent *\fIhostent\fP)
+.B     int \fItimeouts\fP, struct hostent *\fIhostent\fP)
 .PP
 .B void ares_gethostbyname(ares_channel \fIchannel\fP, const char *\fIname\fP,
 .B     int \fIfamily\fP, ares_host_callback \fIcallback\fP, void *\fIarg\fP)
@@ -37,14 +37,11 @@ The parameter
 .I name
 gives the hostname as a NUL-terminated C string, and
 .I family
-gives the desired type of address for the resulting host entry.  When
-the query is complete or has failed, the ares library will invoke
-.IR callback .
-Completion or failure of the query may happen immediately, or may
-happen during a later call to
-.BR ares_process (3)
-or
-.BR ares_destroy (3).
+gives the desired type of address for the resulting host entry.  When the
+query is complete or has failed, the ares library will invoke \fIcallback\fP.
+Completion or failure of the query may happen immediately, or may happen
+during a later call to \fIares_process(3)\fP, \fIares_destroy(3)\fP or
+\fIares_cancel(3)\fP.
 .PP
 The callback argument
 .I arg
@@ -83,6 +80,11 @@ The name service channel
 .I channel
 is being destroyed; the query will not be completed.
 .PP
+The callback argument
+.I timeouts
+reports how many times a query timed out during the execution of the
+given request.
+.PP
 On successful completion of the query, the callback argument
 .I hostent
 points to a
@@ -96,7 +98,8 @@ did not complete successfully,
 will be
 .BR NULL .
 .SH SEE ALSO
-.BR ares_process (3)
+.BR ares_process (3),
+.BR ares_gethostbyaddr (3)
 .SH AUTHOR
 Greg Hudson, MIT Information Systems
 .br