diff options
| -rw-r--r-- | ares/Makefile.inc | 2 | ||||
| -rw-r--r-- | ares/ares_parse_aaaa_reply.3 | 64 |
2 files changed, 65 insertions, 1 deletions
diff --git a/ares/Makefile.inc b/ares/Makefile.inc index d8b1e0608..08e213f88 100644 --- a/ares/Makefile.inc +++ b/ares/Makefile.inc @@ -13,4 +13,4 @@ MANPAGES= ares_destroy.3 ares_expand_name.3 ares_expand_string.3 ares_fds.3 \ ares_gethostbyname.3 ares_init.3 ares_init_options.3 ares_mkquery.3 \ ares_parse_a_reply.3 ares_parse_ptr_reply.3 ares_process.3 \ ares_query.3 ares_search.3 ares_send.3 ares_strerror.3 ares_timeout.3 \ - ares_version.3 ares_cancel.3 + ares_version.3 ares_cancel.3 ares_parse_aaaa_reply.3 diff --git a/ares/ares_parse_aaaa_reply.3 b/ares/ares_parse_aaaa_reply.3 new file mode 100644 index 000000000..15ecd5e99 --- /dev/null +++ b/ares/ares_parse_aaaa_reply.3 @@ -0,0 +1,64 @@ +.\" $Id$ +.\" +.\" Copyright 2005 by Dominick Meglio. +.\" +.\" Permission to use, copy, modify, and distribute this +.\" software and its documentation for any purpose and without +.\" fee is hereby granted, provided that the above copyright +.\" notice appear in all copies and that both that copyright +.\" notice and this permission notice appear in supporting +.\" documentation, and that the name of M.I.T. not be used in +.\" advertising or publicity pertaining to distribution of the +.\" software without specific, written prior permission. +.\" M.I.T. makes no representations about the suitability of +.\" this software for any purpose. It is provided "as is" +.\" without express or implied warranty. +.\" +.TH ARES_PARSE_AAAA_REPLY 3 "10 March 2005" +.SH NAME +ares_parse_aaaa_reply \- Parse a reply to a DNS query of type AAAA into a hostent +.SH SYNOPSIS +.nf +.B #include <ares.h> +.PP +.B int ares_parse_aaaa_reply(const unsigned char *\fIabuf\fP, int \fIalen\fP, +.B struct hostent **\fIhost\fP); +.fi +.SH DESCRIPTION +The +.B ares_parse_aaaa_reply +function parses the response to a query of type AAAA into a +.BR "struct hostent" . +The parameters +.I abuf +and +.I alen +give the contents of the response. The result is stored in allocated +memory and a pointer to it stored into the variable pointed to by +.IR host . +It is the caller's responsibility to free the resulting host structure +using +.BR ares_free_hostent (3) +when it is no longer needed. +.SH RETURN VALUES +.B ares_parse_aaaa_reply +can return any of the following values: +.TP 15 +.B ARES_SUCCESS +The response was successfully parsed. +.TP 15 +.B ARES_EBADRESP +The response was malformatted. +.TP 15 +.B ARES_ENODATA +The response did not contain an answer to the query. +.TP 15 +.B ARES_ENOMEM +Memory was exhausted. +.SH SEE ALSO +.BR ares_gethostbyname (3), +.BR ares_free_hostent (3) +.SH AUTHOR +Dominick Meglio +.br +Copyright 2005 by Dominick Meglio. |