updated g_strndup.

2000-07-01 Damon Chaplin <damon@helixcode.com> * tmpl/string_utils.sgml: updated g_strndup.
dieterv · Jul 1, 2000 · 0df07ab · 0df07ab
1 parent 3250d07
commit 0df07ab
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 6 deletions.
diff --git a/docs/reference/ChangeLog b/docs/reference/ChangeLog
@@ -1,3 +1,7 @@
+2000-07-01  Damon Chaplin  <damon@helixcode.com>
+
+	* tmpl/string_utils.sgml: updated g_strndup.
+
 2000-06-11  Damon Chaplin  <damon@helixcode.com>
 
 	* tmpl/messages.sgml: updated a bit more.

diff --git a/docs/reference/glib/glib/ChangeLog b/docs/reference/glib/glib/ChangeLog
@@ -1,3 +1,7 @@
+2000-07-01  Damon Chaplin  <damon@helixcode.com>
+
+	* tmpl/string_utils.sgml: updated g_strndup.
+
 2000-06-11  Damon Chaplin  <damon@helixcode.com>
 
 	* tmpl/messages.sgml: updated a bit more.

diff --git a/docs/reference/glib/tmpl/string_utils.sgml b/docs/reference/glib/tmpl/string_utils.sgml
@@ -27,15 +27,15 @@ The returned string should be freed when no longer needed.
 
 <!-- ##### FUNCTION g_strndup ##### -->
 <para>
-Duplicates the first @n characters of a string, and null-terminates it.
-If @str is NULL, NULL is returned.
-The returned string should be freed when no longer needed.
+Duplicates the first @n characters of a string, returning a newly-allocated
+buffer @n + 1 characters long which will always be null-terminated.
+If @str is less than @n characters long the buffer is padded with nulls.
+The returned value should be freed when no longer needed.
 </para>
 
 @str: the string to duplicate part of.
-@n: the number of characters to copy, which must be less than or equal to the
-length of @str.
-@Returns: a newly-allocated copy of the first @n characters of @str,
+@n: the maximum number of characters to copy from @str.
+@Returns: a newly-allocated buffer containing the first @n characters of @str,
 null-terminated.