@@ -1246,12 +1246,14 @@ C<utf8n_to_uvchr> is more like an extension of C<utf8_to_uvchr_buf>, but
1246
1246
with fewer quirks, and a different method of specifying the bytes in C<s> it is
1247
1247
allowed to examine. It has a C<curlen> parameter instead of an C<e> parameter,
1248
1248
so the furthest byte in C<s> it can look at is S<C<s + curlen - 1>>. Its
1249
- return value is, like C<utf8_to_uvchr_buf>, ambiguous with respect to the NUL
1250
- and REPLACEMENT characters, but the value of C<*retlen> can be relied on
1251
- (except with the C<UTF8_CHECK_ONLY> flag described below) to know where the
1252
- next possible character along C<s> starts, removing that quirk. Hence, you
1253
- always should use C<*retlen> to determine where the next character in C<s>
1254
- starts.
1249
+ failure return value is not dependent on if warnings are enabled or not. It is
1250
+ always 0 upon failure. But like C<utf8_to_uvchr_buf>, 0 could also be the
1251
+ return for a successful translation of an input C<NUL> character. Use the same
1252
+ method given above for disambiguating this. Unlike C<utf8_to_uvchr_buf>,
1253
+ C<*retlen> can be relied on (except with the C<UTF8_CHECK_ONLY> flag described
1254
+ below) to know where the next possible character along C<s> starts, removing
1255
+ that quirk. Hence, you always should use C<*retlen> to determine where the
1256
+ next character in C<s> starts.
1255
1257
1256
1258
These functions have an additional parameter, C<flags>, besides the ones in
1257
1259
C<utf8_to_uv> and C<utf8_to_uvchr_buf>, which can be used to broaden or
0 commit comments