gconvert: mention that the g_convert len should be in bytes

Some charsets have each char with more than one byte, make it clear that
the length should be in bytes

https://bugzilla.gnome.org/show_bug.cgi?id=730963
This commit is contained in:
Thiago Santos 2014-05-29 19:13:37 -03:00 committed by Ryan Lortie
parent 1e28df0264
commit 79f930f6dc

View File

@ -342,7 +342,7 @@ close_converter (GIConv cd)
/** /**
* g_convert_with_iconv: * g_convert_with_iconv:
* @str: the string to convert * @str: the string to convert
* @len: the length of the string, or -1 if the string is * @len: the length of the string in bytes, or -1 if the string is
* nul-terminated (Note that some encodings may allow nul * nul-terminated (Note that some encodings may allow nul
* bytes to occur inside strings. In that case, using -1 * bytes to occur inside strings. In that case, using -1
* for the @len parameter is unsafe) * for the @len parameter is unsafe)
@ -495,7 +495,7 @@ g_convert_with_iconv (const gchar *str,
/** /**
* g_convert: * g_convert:
* @str: the string to convert * @str: the string to convert
* @len: the length of the string, or -1 if the string is * @len: the length of the string in bytes, or -1 if the string is
* nul-terminated (Note that some encodings may allow nul * nul-terminated (Note that some encodings may allow nul
* bytes to occur inside strings. In that case, using -1 * bytes to occur inside strings. In that case, using -1
* for the @len parameter is unsafe) * for the @len parameter is unsafe)
@ -574,7 +574,7 @@ g_convert (const gchar *str,
/** /**
* g_convert_with_fallback: * g_convert_with_fallback:
* @str: the string to convert * @str: the string to convert
* @len: the length of the string, or -1 if the string is * @len: the length of the string in bytes, or -1 if the string is
* nul-terminated (Note that some encodings may allow nul * nul-terminated (Note that some encodings may allow nul
* bytes to occur inside strings. In that case, using -1 * bytes to occur inside strings. In that case, using -1
* for the @len parameter is unsafe) * for the @len parameter is unsafe)