GitLab repository storage has been migrated to hashed layout. Please contact Infrastructure team if you notice any issues with repositories or hooks.

Commit 5a633f82 authored by Benjamin Otte's avatar Benjamin Otte

Clarify documentation about g_convert() nul-terminated returns

THere is effectively no nul-termination for multibyte characters.
parent f3fbf37d
......@@ -566,8 +566,16 @@ close_converter (GIConv cd)
* </footnote>.
*
* Return value: If the conversion was successful, a newly allocated
* nul-terminated string, which must be freed with
* g_free(). Otherwise %NULL and @error will be set.
* nul-terminated<footnote id="nul-returns">
* <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*
g_convert_with_iconv (const gchar *str,
......@@ -719,8 +727,9 @@ g_convert_with_iconv (const gchar *str,
* conversions<footnoteref linkend="streaming-state"/>.
*
* Return value: If the conversion was successful, a newly allocated
* nul-terminated string, which must be freed with
* g_free(). Otherwise %NULL and @error will be set.
* nul-terminated<footnoteref linkend="nul-returns"/> string,
* which must be freed with g_free(). Otherwise %NULL and
* @error will be set.
**/
gchar*
g_convert (const gchar *str,
......@@ -794,8 +803,9 @@ g_convert (const gchar *str,
* conversions<footnoteref linkend="streaming-state"/>.
*
* Return value: If the conversion was successful, a newly allocated
* nul-terminated string, which must be freed with
* g_free(). Otherwise %NULL and @error will be set.
* nul-terminated<footnoteref linkend="nul-returns"/> string,
* which must be freed with g_free(). Otherwise %NULL and
* @error will be set.
**/
gchar*
g_convert_with_fallback (const gchar *str,
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment