ares_expand_string (3)

Leading comments

Copyright 1998 by the Massachusetts Institute of Technology.

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 pr...

(The comments found at the beginning of the groff file "man3/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

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-terminated 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.

SEE ALSO

ares_free_string(3)

AUTHOR

Dominick Meglio