diff --git a/docs/xml/lazutils/lazutf16.xml b/docs/xml/lazutils/lazutf16.xml index 6e4e35c010..5eb3fbc131 100644 --- a/docs/xml/lazutils/lazutf16.xml +++ b/docs/xml/lazutils/lazutf16.xml @@ -1,13 +1,11 @@ - - Contains routines used for UTF-16 character and string operations. @@ -30,7 +28,6 @@ a UTF-16 table, but it might be extended to include various UTF-16 routines.

- Gets the length of the UTF-16 character in the specified PWideChar value. @@ -39,39 +36,45 @@ Gets the length of the UTF-16 character in the specified PWideChar value. Uses the endian-ness for the platform. Returns 0, 1, or 2. - Length of the UTF-16 character in the value, or 0 when Nil. - PWideChar value examined in the routine. - Gets the length for the specified value in UTF-16 characters. - + +

+Examines 16-UTF values in the specified Unicode string until the number of word +values is exceeded. Using zero (0) in WordCount causes no actions to be +performed in the routine, and the return value is 0. +

+ - - + +Number of UTF-16 codepoints in the examined value. + - - + +Unicode string with the values examined in the routine. + - - + +Pointer to the WideChar values examined in the routine. + - - + +Number of UTF-16 word values to examine in the Unicode string. + - Copies a number of UTF-16 characters at the given character position in the @@ -96,12 +99,19 @@ specified value. - + +Gets a pointer to the character (UTF-16 codepoint) at the specified position +(zero-based) in a WideChar value. + - + +Pointer to the UTF-16 character at the specified position in the value, or +Nil if P is empty or a UTF-16 character is not found at the specified +ordinal position. + PWideChar value with the values examined in the routine. @@ -177,20 +187,16 @@ when p contains an invalid UTF-16 code point. - Unicode code point for the values in p. - UTF-16 code points examined and converted in the routine. - Number of UTF-16 code points for the converted character. - Converts a Unicode character value to its UTF-16 equivalent as a WideString @@ -205,17 +211,18 @@ represent the UTF-16 code point. - WideString value with UTF-16 code point the Unicode character. - Unicode character value converted in the routine. - + +Returns True if the specified values are a valid UTF-16 character +(codepoint). +

Based on the specification defined by the Unicode consortium, at: @@ -235,19 +242,25 @@ any value in the range DC00 to DFFF not preceded by a value in the range D800 to DBFF. [AF]

-Use ANextChar = #0 to indicate that there is no next char. +If ANextChar is set to #0 there is no next character.

- + +Returns False if AChar is #0 or AChar and ANextChar are unpaired surrogates. + - + +First UTF-16 code examined in the method. + - + +Next UTF-16 code examined in the method. + @@ -272,37 +285,55 @@ True if the specified WideString contains valid UTF-16 code points. - + +Replaces a pattern in a Unicode string with another Unicode pattern. +

Same as SysUtil.StringReplace but for WideStrings and -UnicodeStrings, since it's not available in FPC yet. +UnicodeStrings, since it is not available in FPC yet.

- + +StringReplace +TReplaceFlags + - + +Updated value for Unicode string after pattern replacement(s). + - + +Unicode string value examined in the routine. + - + +Unicode string with the pattern to locate in S. + - + +Unicode string with the pattern used to replace the old pattern in S. + - + +Set of replacement flags applied in the routine. + - + +Number of replacements performed in the routine. + - -Converts a Unicode character value to its lowercase equivalent. + +Converts a Unicode character value to its lowercase equivalent. +

Uses internal tables to map Unicode character ranges common to both UTF-16 @@ -311,32 +342,27 @@ and UTF-32. - Cardinal value for the lowercase equivalent of u. - Unicode character vale converted to lowercase in the routine. - -Converts a UTF-8-encoded string to lowercase Unicode values using internal +Converts a UTF-8-encoded string to lowercase UTF-8 values using internal case tables. - -String with the lowercase Unicode values for s. +String with the lowercase UTF-8 values for s. - -String with UTF-8 values converted to lowercase Unicode in the routine. +String with UTF-8 values converted to lowercase UTF-8 in the routine.