daily update

[deliverable/binutils-gdb.git] / libiberty / asprintf.c

diff --git a/libiberty/asprintf.c b/libiberty/asprintf.c
index e09af239ae7d6e45ff271e4bf3091c2634a00672..cd0543aa7ad40a78df65088a503f8677146677fb 100644 (file)
--- a/libiberty/asprintf.c
+++ b/libiberty/asprintf.c
@@ -1,6 +1,6 @@
 /* Like sprintf but provides a pointer to malloc'd storage, which must
    be freed by the caller.
-   Copyright (C) 1997 Free Software Foundation, Inc.
+   Copyright (C) 1997, 2003 Free Software Foundation, Inc.
    Contributed by Cygnus Solutions.
 
 This file is part of the libiberty library.
@@ -28,6 +28,22 @@ Boston, MA 02111-1307, USA.  */
 #include <varargs.h>
 #endif
 
+/*
+
+@deftypefn Extension int asprintf (char **@var{resptr}, const char *@var{format}, ...)
+
+Like @code{sprintf}, but instead of passing a pointer to a buffer, you
+pass a pointer to a pointer.  This function will compute the size of
+the buffer needed, allocate memory with @code{malloc}, and store a
+pointer to the allocated memory in @code{*@var{resptr}}.  The value
+returned is the same as @code{sprintf} would return.  If memory could
+not be allocated, minus one is returned and @code{NULL} is stored in
+@code{*@var{resptr}}.
+
+@end deftypefn
+
+*/
+
 int
 asprintf VPARAMS ((char **buf, const char *fmt, ...))
 {