12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364 |
- .\" $Id$
- .\"
- .\" 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 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_EXPAND_NAME 3 "23 July 1998"
- .SH NAME
- ares_expand_name \- Expand a DNS-encoded domain name
- .SH SYNOPSIS
- .nf
- .B #include <ares.h>
- .PP
- .B int ares_expand_name(const unsigned char *\fIencoded\fP,
- .B const unsigned char *\fIabuf\fP, int \fIalen\fP, char **\fIs\fP,
- .B int *\fIenclen\fP)
- .fi
- .SH DESCRIPTION
- The
- .B ares_expand_name
- function converts a DNS-encoded domain name to a dot-separated C
- string. The argument
- .I encoded
- gives the beginning of the encoded domain name, and the arguments
- .I abuf
- and
- .I 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
- .IR s .
- The length of the encoded name is stored in the variable pointed to by
- .I enclen
- so that the caller can advance past the encoded domain name to read
- further data in the message.
- .SH RETURN VALUES
- .B ares_expand_name
- can return any of the following values:
- .TP 15
- .B ARES_SUCCESS
- Expansion of the encoded name succeeded.
- .TP 15
- .B ARES_EBADNAME
- The encoded domain name was malformed and could not be expanded.
- .TP 15
- .B ARES_ENOMEM
- Memory was exhausted.
- .SH SEE ALSO
- .BR ares_mkquery (3)
- .SH AUTHOR
- Greg Hudson, MIT Information Systems
- .br
- Copyright 1998 by the Massachusetts Institute of Technology.
|