diff --git a/utf8.c b/utf8.c index dd00149421b3..a1d978cbefd1 100644 --- a/utf8.c +++ b/utf8.c @@ -1246,12 +1246,14 @@ C is more like an extension of C, but with fewer quirks, and a different method of specifying the bytes in C it is allowed to examine. It has a C parameter instead of an C parameter, so the furthest byte in C it can look at is S>. Its -return value is, like C, ambiguous with respect to the NUL -and REPLACEMENT characters, but the value of C<*retlen> can be relied on -(except with the C flag described below) to know where the -next possible character along C starts, removing that quirk. Hence, you -always should use C<*retlen> to determine where the next character in C -starts. +failure return value is not dependent on if warnings are enabled or not. It is +always 0 upon failure. But like C, 0 could also be the +return for a successful translation of an input C character. Use the same +method given above for disambiguating this. Unlike C, +C<*retlen> can be relied on (except with the C flag described +below) to know where the next possible character along C starts, removing +that quirk. Hence, you always should use C<*retlen> to determine where the +next character in C starts. These functions have an additional parameter, C, besides the ones in C and C, which can be used to broaden or