luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2025-03-31 04:43:06 +02:00
Code Issues Packages Projects Releases Wiki Activity

Improve docs for g_utf16_to_utf8

Browse Source 
Document that g_utf16_to_utf8 does not validate the resulting
UTF-8 string. See bug 596314.
This commit is contained in:
Matthias Clasen 2009-09-29 20:39:39 -04:00
parent 5fdb169b72
commit 442dadf311
1 changed files with 11 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
glib/gutf8.c
View File

@ -1085,9 +1085,15 @@ g_ucs4_to_utf8 (const gunichar *str,
* *
* Note that the input is expected to be already in native endianness, * Note that the input is expected to be already in native endianness,
* an initial byte-order-mark character is not handled specially. * an initial byte-order-mark character is not handled specially.
* g_convert() can be used to convert a byte buffer of UTF-16 data of * g_convert() can be used to convert a byte buffer of UTF-16 data of
* ambiguous endianess. * ambiguous endianess.
* *
* Further note that this function does not validate the result
* string; it may e.g. include embedded NUL characters. The only
* validation done by this function is to ensure that the input can
* be correctly interpreted as UTF-16, i.e. it doesn't contain
* things unpaired surrogates.
*
* Return value: a pointer to a newly allocated UTF-8 string. * Return value: a pointer to a newly allocated UTF-8 string.
* This value must be freed with g_free(). If an * This value must be freed with g_free(). If an
* error occurs, %NULL will be returned and * error occurs, %NULL will be returned and
@ -1095,9 +1101,9 @@ g_ucs4_to_utf8 (const gunichar *str,
**/ **/
gchar * gchar *
g_utf16_to_utf8 (const gunichar2 *str, g_utf16_to_utf8 (const gunichar2 *str,
glong len, glong len,
glong *items_read, glong *items_read,
glong *items_written, glong *items_written,
GError **error) GError **error)
{ {
/* This function and g_utf16_to_ucs4 are almost exactly identical - The lines that differ /* This function and g_utf16_to_ucs4 are almost exactly identical - The lines that differ