Change calling convention of xmem_cd_iconv.

2 files changed, 9 insertions, 6 deletions

diff --git a/ChangeLog b/ChangeLog
index a6a27d8d8a..591fbccf76 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,5 +1,7 @@
 2007-01-21  Bruno Haible  <bruno@clisp.org>
 
+	* lib/xstriconv.h: Update.
+
 	* lib/striconv.h (mem_cd_iconv): Change specification.
 	* lib/striconv.c (mem_cd_iconv): Don't free the user-supplied original
 	result buffer.
diff --git a/lib/xstriconv.h b/lib/xstriconv.h
index 8602a0c2ce..0d42758e87 100644
--- a/lib/xstriconv.h
+++ b/lib/xstriconv.h
@@ -1,5 +1,5 @@
 /* Charset conversion with out-of-memory checking.
-   Copyright (C) 2001-2004, 2006 Free Software Foundation, Inc.
+   Copyright (C) 2001-2004, 2006-2007 Free Software Foundation, Inc.
    Written by Bruno Haible and Simon Josefsson.
 
    This program is free software; you can redistribute it and/or modify
@@ -35,13 +35,14 @@ extern "C" {
 /* Convert an entire string from one encoding to another, using iconv.
    The original string is at [SRC,...,SRC+SRCLEN-1].
    The conversion descriptor is passed as CD.
-   *RESULTP should initially contain NULL or a malloced memory block.
-   May change the size of the allocated memory block in *RESULTP, storing
-   its new address in *RESULTP and its new length in *LENGTHP.
+   *RESULTP and *LENGTH should initially be a scratch buffer and its size,
+   or *RESULTP can initially be NULL.
+   May erase the contents of the memory at *RESULTP.
    Upon memory allocation failure, report the error and exit.
    Return value: 0 if successful, otherwise -1 and errno set.
-   If successful, the resulting string is stored in *RESULTP and its length
-   in *LENGTHP.  */
+   If successful: The resulting string is stored in *RESULTP and its length
+   in *LENGTHP.  *RESULTP is set to a freshly allocated memory block, or is
+   unchanged if no dynamic memory allocation was necessary.  */
 extern int xmem_cd_iconv (const char *src, size_t srclen, iconv_t cd,
 			  char **resultp, size_t *lengthp);