Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

ares_expand_string (3)

Name

ares_expand_string - Expand a length encoded string

Synopsis

#include <ares.h>

int ares_expand_string(const unsigned char *encoded,
const unsigned char *abuf, int alen, unsigned char **s,
long *enclen)

Description

ARES_EXPAND_NAME(3)        Library Functions Manual        ARES_EXPAND_NAME(3)



NAME
       ares_expand_string - Expand a length encoded string

SYNOPSIS
       #include <ares.h>

       int ares_expand_string(const unsigned char *encoded,
       const unsigned char *abuf, int alen, unsigned char **s,
            long *enclen)

DESCRIPTION
       The  ares_expand_string  function converts a length encoded string to a
       NUL-terminated C string.  The argument encoded gives the  beginning  of
       the encoded string, and the arguments abuf and alen give the containing
       message buffer (necessary for the processing  of  indirection  pointers
       within  the encoded domain name).  The result is placed in a NUL-termi-
       nated allocated buffer, a pointer to which is stored  in  the  variable
       pointed  to  by  s.   The length of the encoded string is stored in the
       variable pointed to by enclen so that the caller can advance  past  the
       encoded string to read further data in the message.

RETURN VALUES
       ares_expand_string can return any of the following values:

       ARES_SUCCESS   Expansion of the encoded string succeeded.

       ARES_EBADSTR   The  encoded  string  was  malformed  and  could  not be
                      expanded.

       ARES_ENOMEM    Memory was exhausted.


ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+------------------+
       |ATTRIBUTE TYPE | ATTRIBUTE VALUE  |
       +---------------+------------------+
       |Availability   | library/libcares |
       +---------------+------------------+
       |Stability      | Volatile         |
       +---------------+------------------+

SEE ALSO
       ares_free_string(3)

AUTHOR
       Dominick Meglio



NOTES
       Source code for open source software components in Oracle  Solaris  can
       be found at https://www.oracle.com/downloads/opensource/solaris-source-
       code-downloads.html.

       This    software    was    built    from    source     available     at
       https://github.com/oracle/solaris-userland.    The  original  community
       source   was   downloaded   from     https://c-ares.haxx.se/download/c-
       ares-1.17.2.tar.gz.

       Further information about this software can be found on the open source
       community website at https://c-ares.haxx.se/.



                                  20 Nov 2009              ARES_EXPAND_NAME(3)