2 .\" Copyright 1998 by the Massachusetts Institute of Technology.
4 .\" Permission to use, copy, modify, and distribute this
5 .\" software and its documentation for any purpose and without
6 .\" fee is hereby granted, provided that the above copyright
7 .\" notice appear in all copies and that both that copyright
8 .\" notice and this permission notice appear in supporting
9 .\" documentation, and that the name of M.I.T. not be used in
10 .\" advertising or publicity pertaining to distribution of the
11 .\" software without specific, written prior permission.
12 .\" M.I.T. makes no representations about the suitability of
13 .\" this software for any purpose. It is provided "as is"
14 .\" without express or implied warranty.
16 .TH ARES_PARSE_SOA_REPLY 3 "29 May 2012"
18 ares_parse_soa_reply \- Parse a reply to a DNS query of type SOA
23 .B int ares_parse_soa_reply(const unsigned char* \fIabuf\fP, int \fIalen\fP,
24 .B struct ares_soa_reply** \fIsoa_out\fP);
28 .B ares_parse_soa_reply
29 function parses the response to a query of type SOA into a
30 .IR struct\ ares_soa_reply .
35 give the contents of the response. The result is stored in allocated
36 memory and a pointer to it stored into the variable pointed to by
38 It is the caller's responsibility to free the resulting
40 structure when it is no longer needed using the function
45 contains the following fields:
49 struct ares_soa_reply {
62 .B ares_parse_soa_reply
63 can return any of the following values:
66 The response was successfully parsed.
69 The response was malformatted.
72 The response did not contain an answer to the query.
77 This function was first introduced in c-ares version 1.9.0.
80 .BR ares_free_data (3)