ares_parse_txt_reply.3

   1 .\"
   2 .\" Copyright 1998 by the Massachusetts Institute of Technology.
   3 .\"
   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.
  15 .\"
  16 .TH ARES_PARSE_TXT_REPLY 3 "27 October 2009"
  17 .SH NAME
  18 ares_parse_txt_reply \- Parse a reply to a DNS query of type TXT
  19 .SH SYNOPSIS
  20 .nf
  21 .B #include <ares.h>
  22 .PP
  23 .B int ares_parse_txt_reply(const unsigned char* \fIabuf\fP, int \fIalen\fP,
  24 .B                         struct ares_txt_reply **\fItxt_out\fP);
  25 .fi
  26 .SH DESCRIPTION
  27 The
  28 .B ares_parse_txt_reply
  29 function parses the response to a query of type TXT into a
  30 linked list (one element per sub-string) of
  31 .I struct ares_txt_reply
  32 The parameters
  33 .I abuf
  34 and
  35 .I alen
  36 give the contents of the response.  The result is stored in allocated
  37 memory and a pointer to it stored into the variable pointed to by
  38 .IR txt_out .
  39 It is the caller's responsibility to free the resulting
  40 .IR txt_out
  41 structure when it is no longer needed using the function
  42 .B ares_free_data
  43 .PP
  44 The structure
  45 .I ares_txt_reply
  46 contains the following fields:
  47 .sp
  48 .in +4n
  49 .nf
  50 struct ares_txt_reply {
  51   struct ares_txt_reply  *next;
  52   unsigned int  length;
  53   unsigned char *txt;
  54 };
  55 .fi
  56 .in
  57 .PP
  58 .SH RETURN VALUES
  59 .B ares_parse_txt_reply
  60 can return any of the following values:
  61 .TP 15
  62 .B ARES_SUCCESS
  63 The response was successfully parsed.
  64 .TP 15
  65 .B ARES_EBADRESP
  66 The response was malformatted.
  67 .TP 15
  68 .B ARES_ENODATA
  69 The response did not contain an answer to the query.
  70 .TP 15
  71 .B ARES_ENOMEM
  72 Memory was exhausted.
  73 .SH AVAILABILITY
  74 This function was first introduced in c-ares version 1.7.0.
  75 .SH SEE ALSO
  76 .BR ares_query (3)
  77 .BR ares_free_data (3)
  78 .SH AUTHOR
  79 Written by Jakub Hrozek <jhrozek@redhat.com>, on behalf of Red Hat, Inc http://www.redhat.com
  80