luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2025-01-11 23:16:14 +01:00
Code Issues Packages Projects Releases Wiki Activity

Clarify documentation about g_convert() nul-terminated returns

Browse Source 
THere is effectively no nul-termination for multibyte characters.
This commit is contained in:
Benjamin Otte 2009-10-27 21:07:13 +01:00
parent f3fbf37dd8
commit 5a633f82db
1 changed files with 16 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
glib/gconvert.c
View File

@ -566,8 +566,16 @@ close_converter (GIConv cd)
* </footnote>. * </footnote>.
* *
* Return value: If the conversion was successful, a newly allocated * Return value: If the conversion was successful, a newly allocated
* nul-terminated string, which must be freed with * nul-terminated<footnote id="nul-returns">
* g_free(). Otherwise %NULL and @error will be set. * <para>
* Nul-terminated return values from conversion functions
* are terminated by a single 0 byte only. This means that
* for multibyte character sets like UTF-16, they must be
* treated as not nul-terminated.
* </para>
* </footnote>
* string, which must be freed with g_free(). Otherwise %NULL
* and @error will be set.
**/ **/
gchar* gchar*
g_convert_with_iconv (const gchar *str, g_convert_with_iconv (const gchar *str,
@ -719,8 +727,9 @@ g_convert_with_iconv (const gchar *str,
* conversions<footnoteref linkend="streaming-state"/>. * conversions<footnoteref linkend="streaming-state"/>.
* *
* Return value: If the conversion was successful, a newly allocated * Return value: If the conversion was successful, a newly allocated
* nul-terminated string, which must be freed with * nul-terminated<footnoteref linkend="nul-returns"/> string,
* g_free(). Otherwise %NULL and @error will be set. * which must be freed with g_free(). Otherwise %NULL and
* @error will be set.
**/ **/
gchar* gchar*
g_convert (const gchar *str, g_convert (const gchar *str,
@ -794,8 +803,9 @@ g_convert (const gchar *str,
* conversions<footnoteref linkend="streaming-state"/>. * conversions<footnoteref linkend="streaming-state"/>.
* *
* Return value: If the conversion was successful, a newly allocated * Return value: If the conversion was successful, a newly allocated
* nul-terminated string, which must be freed with * nul-terminated<footnoteref linkend="nul-returns"/> string,
* g_free(). Otherwise %NULL and @error will be set. * which must be freed with g_free(). Otherwise %NULL and
* @error will be set.
**/ **/
gchar* gchar*
g_convert_with_fallback (const gchar *str, g_convert_with_fallback (const gchar *str,