Diffstat (limited to 'ares_expand_string.3')
1 files changed, 62 insertions, 0 deletions
diff --git a/ares_expand_string.3 b/ares_expand_string.3
new file mode 100644
@@ -0,0 +1,62 @@
+.\" 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"
+ares_expand_string \- Expand a length encoded string
+.B #include <ares.h>
+.B int ares_expand_string(const unsigned char *\fIencoded\fP,
+.B const unsigned char *\fIabuf\fP, int \fIalen\fP, unsigned char **\fIs\fP,
+.B int *\fIenclen\fP)
+function converts a length encoded string to a NULL terminated C
+string. The argument
+gives the beginning of the encoded string, and the arguments
+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 string is stored in the variable pointed to by
+so that the caller can advance past the encoded string to read
+further data in the message.
+.SH RETURN VALUES
+can return any of the following values:
+Expansion of the encoded string succeeded.
+The encoded string was malformed and could not be expanded.
+Memory was exhausted.
+.SH SEE ALSO
+.BR ares_free_string (3)