mirror of
https://gitlab.com/freepascal.org/lazarus/lazarus.git
synced 2025-04-05 17:17:52 +02:00
3301 lines
103 KiB
XML
3301 lines
103 KiB
XML
<?xml version="1.0" encoding="UTF-8"?>
|
|
<!--
|
|
|
|
Documentation for LCL (Lazarus Component Library) and LazUtils (Lazarus
|
|
Utilities) are published under the Creative Commons Attribution-ShareAlike 4.0
|
|
International public license.
|
|
|
|
https://creativecommons.org/licenses/by-sa/4.0/legalcode.txt
|
|
https://gitlab.com/freepascal.org/lazarus/lazarus/-/blob/main/docs/cc-by-sa-4-0.txt
|
|
|
|
Copyright (c) 1997-2025, by the Lazarus Development Team.
|
|
|
|
-->
|
|
<fpdoc-descriptions>
|
|
<package name="lazutils">
|
|
<!--
|
|
====================================================================
|
|
LConvEncoding
|
|
====================================================================
|
|
-->
|
|
<module name="LConvEncoding">
|
|
<short>
|
|
Contains routines used to perform conversions between Unicode and System Code
|
|
Page encodings.
|
|
</short>
|
|
<descr>
|
|
<p>
|
|
<file>lconvencoding.pas</file> provides types, variable, constants, and
|
|
routines used to perform conversions to and from Unicode and /or System Code
|
|
Page encodings. Functions in this unit are thread-safe.
|
|
</p>
|
|
<p>
|
|
For environments where the RTL uses UTF-8 encoding, the UseSystemCPConv
|
|
compiler define is enabled to include System Code Page conversions.
|
|
</p>
|
|
<p>
|
|
<file>lconvencoding.pas</file> is part of the <file>LazUtils</file> package.
|
|
</p>
|
|
</descr>
|
|
|
|
<!-- unresolved external references -->
|
|
<element name="SysUtils"/>
|
|
<element name="Classes"/>
|
|
<element name="Dos"/>
|
|
<element name="LazUTF8"/>
|
|
<element name="CodepagesCommon"/>
|
|
<element name="CodepagesAsian"/>
|
|
<element name="iconvenc"/>
|
|
|
|
<element name="TConvertEncodingErrorMode">
|
|
<short>
|
|
Represents the behaviors for an error occurring in an encoding conversion.
|
|
</short>
|
|
<descr>
|
|
<p>
|
|
<var>TConvertEncodingErrorMode</var> is an enumerated type with values that
|
|
represent the behavior applied when an encoding conversion error is detected.
|
|
TConvertEncodingErrorMode is the type used for the
|
|
<var>ConvertEncodingErrorMode</var> variable.
|
|
</p>
|
|
</descr>
|
|
<version>
|
|
Introduced in version 2.2.
|
|
</version>
|
|
<seealso>
|
|
<link id="ConvertEncodingErrorMode"/>
|
|
</seealso>
|
|
</element>
|
|
<element name="TConvertEncodingErrorMode.ceemSkip">
|
|
<short>Skip or ignore the encoding conversion error.</short>
|
|
</element>
|
|
<element name="TConvertEncodingErrorMode.ceemException">
|
|
<short>
|
|
Raises an EConvertError exception with a message relevant to the conversion
|
|
error.
|
|
</short>
|
|
</element>
|
|
<element name="TConvertEncodingErrorMode.ceemReplace">
|
|
<short>
|
|
Replace the suspect value with an error placeholder (usually the '?'
|
|
character).
|
|
</short>
|
|
</element>
|
|
<element name="TConvertEncodingErrorMode.ceemReturnEmpty">
|
|
<short>Return an empty string ('') for the suspect value.</short>
|
|
</element>
|
|
|
|
<element name="ConvertEncodingErrorMode">
|
|
<short>Error handling behavior for encoding conversion errors.</short>
|
|
<descr>
|
|
<p>
|
|
<var>ConvertEncodingErrorMode</var> is a unit global
|
|
<var>TConvertEncodingErrorMode</var> variable which controls the behavior
|
|
when an error is detected in an encoding conversion routine. For example:
|
|
</p>
|
|
<ul>
|
|
<li>UTF-8 to single byte encoding</li>
|
|
<li>DBCS (Asian code pages) encoding to UTF-8</li>
|
|
<li>UTF-8 to DBCS (Double Byte Character Sets)</li>
|
|
</ul>
|
|
<p>
|
|
The default value for the variable is <var>ceemSkip</var>, and indicates that
|
|
an error is skipped or ignored when encountered in an encoding conversion.
|
|
</p>
|
|
</descr>
|
|
<version>
|
|
Introduced in version 2.2. Replaces use of the
|
|
ConvertEncodingErrorRaisesException variable.
|
|
</version>
|
|
<seealso>
|
|
<link id="TConvertEncodingErrorMode"/>
|
|
<link id="UTF8ToSingleByte"/>
|
|
</seealso>
|
|
</element>
|
|
|
|
<element name="EncodingUTF8">
|
|
<short>Encoding name for UTF-8.</short>
|
|
</element>
|
|
<element name="EncodingAnsi">
|
|
<short>Encoding name for ANSI.</short>
|
|
</element>
|
|
<element name="EncodingUTF8BOM">
|
|
<short>Encoding name for UTF-8 with a byte order mark.</short>
|
|
</element>
|
|
<element name="EncodingUCS2LE">
|
|
<short>Encoding name for UCS 2-byte Little Endian.</short>
|
|
</element>
|
|
<element name="EncodingUCS2BE">
|
|
<short>Encoding name for UCS 2-byte Big Endian.</short>
|
|
</element>
|
|
<element name="EncodingCP1250">
|
|
<short>Encoding name for Code Page 1250.</short>
|
|
</element>
|
|
<element name="EncodingCP1251">
|
|
<short>Encoding name for Code Page 1251.</short>
|
|
</element>
|
|
<element name="EncodingCP1252">
|
|
<short>Encoding name for Code Page 1252.</short>
|
|
</element>
|
|
<element name="EncodingCP1253">
|
|
<short>Encoding name for Code Page 1253.</short>
|
|
</element>
|
|
<element name="EncodingCP1254">
|
|
<short>Encoding name for Code Page 1254.</short>
|
|
</element>
|
|
<element name="EncodingCP1255">
|
|
<short>Encoding name for Code Page 1255.</short>
|
|
</element>
|
|
<element name="EncodingCP1256">
|
|
<short>Encoding name for Code Page 1256.</short>
|
|
</element>
|
|
<element name="EncodingCP1257">
|
|
<short>Encoding name for Code Page 1257.</short>
|
|
</element>
|
|
<element name="EncodingCP1258">
|
|
<short>Encoding name for Code Page 1258.</short>
|
|
</element>
|
|
<element name="EncodingCP437">
|
|
<short>Encoding name for Code Page 437.</short>
|
|
</element>
|
|
<element name="EncodingCP850">
|
|
<short>Encoding name for Code Page 850.</short>
|
|
</element>
|
|
<element name="EncodingCP852">
|
|
<short>Encoding name for Code Page 852.</short>
|
|
</element>
|
|
<element name="EncodingCP865">
|
|
<short>Encoding name for Code Page 865.</short>
|
|
</element>
|
|
<element name="EncodingCP866">
|
|
<short>Encoding name for Code Page 866.</short>
|
|
</element>
|
|
<element name="EncodingCP874">
|
|
<short>Encoding name for Code Page 874.</short>
|
|
</element>
|
|
<element name="EncodingCP932">
|
|
<short>Encoding name for Code Page 932.</short>
|
|
</element>
|
|
<element name="EncodingCP936">
|
|
<short>Encoding name for Code Page 936.</short>
|
|
</element>
|
|
<element name="EncodingCP949">
|
|
<short>Encoding name for Code Page 949.</short>
|
|
</element>
|
|
<element name="EncodingCP950">
|
|
<short>Encoding name for Code Page 950.</short>
|
|
</element>
|
|
<element name="EncodingCPMac">
|
|
<short>Encoding name for the Macintosh Code Page.</short>
|
|
</element>
|
|
<element name="EncodingCPKOI8R">
|
|
<short>Encoding name for KOI8-R Code Page.</short>
|
|
</element>
|
|
<element name="EncodingCPKOI8U">
|
|
<short>Encoding name for KOI8-U Code Page.</short>
|
|
</element>
|
|
<element name="EncodingCPKOI8RU">
|
|
<short>Encoding name for KOI8-RU Code Page.</short>
|
|
</element>
|
|
<element name="EncodingCPIso1">
|
|
<short>Encoding name for ISO 8859-1 Code Page.</short>
|
|
</element>
|
|
<element name="EncodingCPIso2">
|
|
<short>Encoding name for ISO 8859-2 Code Page.</short>
|
|
</element>
|
|
<element name="EncodingCPIso3">
|
|
<short>Encoding name for ISO 8859-3 Code Page.</short>
|
|
</element>
|
|
<element name="EncodingCPIso4">
|
|
<short>Encoding name for ISO 8859-4 Code Page.</short>
|
|
</element>
|
|
<element name="EncodingCPIso5">
|
|
<short>Encoding name for ISO 8859-5 Code Page.</short>
|
|
</element>
|
|
<element name="EncodingCPIso7">
|
|
<short>Encoding name for ISO 8859-7 Code Page.</short>
|
|
</element>
|
|
<element name="EncodingCPIso9">
|
|
<short>Encoding name for ISO 8859-9 Code Page.</short>
|
|
</element>
|
|
<element name="EncodingCPIso10">
|
|
<short>Encoding name for ISO 8859-10 Code Page.</short>
|
|
</element>
|
|
<element name="EncodingCPIso13">
|
|
<short>Encoding name for ISO 8859-13 Code Page.</short>
|
|
</element>
|
|
<element name="EncodingCPIso14">
|
|
<short>Encoding name for ISO 8859-14 Code Page.</short>
|
|
</element>
|
|
<element name="EncodingCPIso15">
|
|
<short>Encoding name for ISO 8859-15 Code Page.</short>
|
|
</element>
|
|
<element name="EncodingCPIso16">
|
|
<short>Encoding name for ISO 8859-16 Code Page.</short>
|
|
</element>
|
|
|
|
<element name="UTF8BOM">
|
|
<short>ANSI representation for the UTF-8 Byte Order Mark.</short>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<element name="UTF16BEBOM">
|
|
<short>ANSI representation for the UTF-16 Big Endian Byte Order Mark.</short>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<element name="UTF16LEBOM">
|
|
<short>
|
|
ANSI representation for the UTF-16 Little Endian Byte Order Mark.
|
|
</short>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<element name="UTF32BEBOM">
|
|
<short>ANSI representation for the UTF-32 Big Endian Byte Order Mark.</short>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<element name="UTF32LEBOM">
|
|
<short>
|
|
ANSI representation for the UTF-32 Little Endian Byte Order Mark.
|
|
</short>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
|
|
<element name="GuessEncoding">
|
|
<short>Tries to determine the encoding used for the specified value.</short>
|
|
<descr>
|
|
<p>
|
|
<var>GuessEncoding</var> is a <var>String</var> function which tries to
|
|
determine the encoding used for the value specified in <var>S</var>. The
|
|
return value contains an encoding name, like 'utf8' or 'ISO-8859-1'. It may
|
|
contain an empty string ('') when S is also an empty string.
|
|
</p>
|
|
<p>
|
|
GuessEncoding checks S for various Byte Order Marks at the start of the
|
|
value, including: <var>UTF8BOM</var>, <var>UTF16LEBOM</var>, and
|
|
<var>UTF16BEBOM</var>. When present, the BOM determines the encoding used for
|
|
the value.
|
|
</p>
|
|
<p>
|
|
Next, it checks for an explicit '<b>{%encoding</b>' marker at the start of
|
|
the value. When present, the value after the marker (up to the closing
|
|
'<b>}</b>' character) is normalized and used as the return value.
|
|
</p>
|
|
<p>
|
|
Finally, it checks for a valid UTF-8 encoding (which includes ASCII
|
|
characters). All characters in S are examined until a character whose UTF-8
|
|
code point is not valid is encountered.
|
|
</p>
|
|
<p>
|
|
When <var>EncodingValid</var> is <b>True</b>, <var>EncodingAnsi</var> is
|
|
assumed. Otherwise, the default encoding for the platform is used. When the
|
|
return value is <var>EncodingUTF8</var>, it is changed to
|
|
'<b>ISO-8859-1</b>'. This is done because the system may use the UTF-8
|
|
encoding, but the value in S does not. ISO 8859-1 has a full mapping to
|
|
Unicode, and this prevents data loss in encoding conversions.
|
|
</p>
|
|
</descr>
|
|
<seealso/>
|
|
</element>
|
|
<element name="GuessEncoding.Result">
|
|
<short>Encoding name detected, or a default value.</short>
|
|
</element>
|
|
<element name="GuessEncoding.s">
|
|
<short>String with the content examined in the routine.</short>
|
|
</element>
|
|
|
|
<element name="ConvertEncodingFromUTF8">
|
|
<short>
|
|
Converts the encoded value from UTF-8 to the encoding with the specified name.
|
|
</short>
|
|
<descr>
|
|
<p>
|
|
The s argument contains the UTF-8-encoded value converted in the routine.
|
|
</p>
|
|
<p>
|
|
ToEncoding is a String value with the name for the target encoding. It is
|
|
normalized in the routine to remove hyphen characters in the encoding name.
|
|
The value corresponds to the encoding name constants defined in the unit, and
|
|
is used to determine which routine is called to perform the encoding
|
|
conversion.
|
|
</p>
|
|
<p>
|
|
For example, the following is a sample of the encoding names and their
|
|
corresponding conversion routines:
|
|
</p>
|
|
<dl>
|
|
<dt>EncodingUTF8BOM ('utf8bom')</dt>
|
|
<dd>UTF8ToUTF8BOM</dd>
|
|
<dt>EncodingCPIso1 ('iso88591')</dt>
|
|
<dd>UTF8ToISO_8859_1</dd>
|
|
<dt>EncodingCPIso2 ('iso88592')</dt>
|
|
<dd>UTF8ToISO_8859_2</dd>
|
|
<dt>EncodingCPIso3 ('iso88593')</dt>
|
|
<dd>UTF8ToISO_8859_3</dd>
|
|
<dt>EncodingCPIso4 ('iso88594')</dt>
|
|
<dd>UTF8ToISO_8859_4</dd>
|
|
<dt>EncodingCPIso5 ('iso88595')</dt>
|
|
<dd>UTF8ToISO_8859_5</dd>
|
|
<dt>EncodingCPIso7 ('iso88597')</dt>
|
|
<dd>UTF8ToISO_8859_7</dd>
|
|
<dt>EncodingCPIso9 ('iso88599')</dt>
|
|
<dd>UTF8ToISO_8859_9</dd>
|
|
<dt>EncodingCPIso10 ('iso885910')</dt>
|
|
<dd>UTF8ToISO_8859_10</dd>
|
|
<dt>EncodingCPIso13 ('iso885913')</dt>
|
|
<dd>UTF8ToISO_8859_13</dd>
|
|
<dt>EncodingCPIso14 ('iso885914')</dt>
|
|
<dd>UTF8ToISO_8859_14</dd>
|
|
<dt>EncodingCPIso15 ('iso885915')</dt>
|
|
<dd>UTF8ToISO_8859_15</dd>
|
|
<dt>EncodingCPIso16 ('iso885916')</dt>
|
|
<dd>UTF8ToISO_8859_16</dd>
|
|
<dt>EncodingCP1250 ('cp1250')</dt>
|
|
<dd>UTF8ToCP1250</dd>
|
|
<dt>EncodingCP1251 ('cp1251')</dt>
|
|
<dd>UTF8ToCP1251</dd>
|
|
<dt>EncodingCP1252 ('cp1252')</dt>
|
|
<dd>UTF8ToCP1252</dd>
|
|
<dt>EncodingCP1253 ('cp1253')</dt>
|
|
<dd>UTF8ToCP1253</dd>
|
|
<dt>EncodingCP1254 ('cp1254')</dt>
|
|
<dd>UTF8ToCP1254</dd>
|
|
<dt>EncodingCP1255 ('cp1255')</dt>
|
|
<dd>UTF8ToCP1255</dd>
|
|
<dt>EncodingCP1256 ('cp1256')</dt>
|
|
<dd>UTF8ToCP1256</dd>
|
|
<dt>EncodingCP1257 ('cp1257')</dt>
|
|
<dd>UTF8ToCP1257</dd>
|
|
<dt>EncodingCP1258 ('cp1258')</dt>
|
|
<dd>UTF8ToCP1258</dd>
|
|
<dt>EncodingCP850 ('cp850')</dt>
|
|
<dd>UTF8ToCP850</dd>
|
|
<dt>EncodingCP852 ('cp852')</dt>
|
|
<dd>UTF8ToCP852</dd>
|
|
<dt>EncodingCP865 ('cp865')</dt>
|
|
<dd>UTF8ToCP865</dd>
|
|
<dt>EncodingCP866 ('cp866')</dt>
|
|
<dd>UTF8ToCP866</dd>
|
|
<dt>EncodingCP874 ('cp874')</dt>
|
|
<dd>UTF8ToCP874</dd>
|
|
<dt>EncodingCPKOI8R ('koi8r')</dt>
|
|
<dd>UTF8ToKOI8R</dd>
|
|
<dt>EncodingCPKOI8U ('koi8u')</dt>
|
|
<dd>UTF8ToKOI8U</dd>
|
|
<dt>EncodingCPKOI8RU ('koi8ru')</dt>
|
|
<dd>UTF8ToKOI8RU</dd>
|
|
<dt>EncodingCPMac ('macinstosh')</dt>
|
|
<dd>UTF8ToMacinstosh</dd>
|
|
<dt>EncodingUCS2LE ('ucs2le')</dt>
|
|
<dd>UTF8ToUCS2LE</dd>
|
|
<dt>EncodingUCS2BE ('ucs2be')</dt>
|
|
<dd>UTF8ToUCS2BE</dd>
|
|
<dt>EncodingAnsi ('ansi')</dt>
|
|
<dd>ConvertUTF8ToAnsi</dd>
|
|
</dl>
|
|
<p>
|
|
Encoded is a Boolean output parameter which indicates if a routine was found
|
|
to perform the requested conversion. Its value is <b>False</b> when a
|
|
conversion routine was not found for the target encoding in ToEncoding.
|
|
</p>
|
|
<p>
|
|
SetTargetCodePage is a Boolean argument which indicates if SetCodePage is
|
|
called to apply a translated code page for the converted value. The default
|
|
value for the argument is <b>False</b>, and omits the code page for the
|
|
return value.
|
|
</p>
|
|
<p>
|
|
ConvertEncodingFromUTF8 is used in the implementation of the ConvertEncoding
|
|
function.
|
|
</p>
|
|
</descr>
|
|
<seealso>
|
|
<link id="ConvertEncoding"/>
|
|
<link id="NormalizeEncoding"/>
|
|
<link id="ConvertEncodingToUTF8"/>
|
|
</seealso>
|
|
</element>
|
|
<element name="ConvertEncodingFromUTF8.Result">
|
|
<short>String value after conversion to the specified encoding.</short>
|
|
</element>
|
|
<element name="ConvertEncodingFromUTF8.s">
|
|
<short>UTF-8-encoded value converted in the routine.</short>
|
|
</element>
|
|
<element name="ConvertEncodingFromUTF8.ToEncoding">
|
|
<short>Encoding name for the converted value.</short>
|
|
</element>
|
|
<element name="ConvertEncodingFromUTF8.Encoded">
|
|
<short>
|
|
<b>True</b> if the return value contains multi-byte encoded values,
|
|
<b>False</b> if it contains a single-byte ANSI string.
|
|
</short>
|
|
</element>
|
|
<element name="ConvertEncodingFromUTF8.SetTargetCodePage">
|
|
<short>
|
|
<b>True</b> if the code page should be set for the return value, <b>False</b>
|
|
if a code page is not used.
|
|
</short>
|
|
</element>
|
|
|
|
<element name="ConvertEncodingToUTF8">
|
|
<short>Converts the specified string value to the UTF-8 encoding.</short>
|
|
<descr>
|
|
<p>
|
|
ConvertEncodingToUTF8 converts the encoding for a string value from the
|
|
specified encoding to UTF-8. The s argument contains the string value
|
|
converted in the routine.
|
|
</p>
|
|
<p>
|
|
FromEncoding is a String value with the name for the existing encoding is s.
|
|
It is normalized in the routine to remove hyphen characters in the encoding
|
|
name. The value corresponds to the encoding name constants defined in the
|
|
unit, and is used to determine which routine is called to perform the
|
|
encoding conversion.
|
|
</p>
|
|
<p>
|
|
For example, the following is a sample of the encoding names and their
|
|
corresponding conversion routines:
|
|
</p>
|
|
<dl>
|
|
<dt>EncodingUTF8BOM ('utf8bom')</dt>
|
|
<dd>UTF8BOMToUTF8</dd>
|
|
<dt>EncodingCPIso1 ('iso88591')</dt>
|
|
<dd>ISO_8859_1ToUTF8</dd>
|
|
<dt>EncodingCPIso2 ('iso88592')</dt>
|
|
<dd>ISO_8859_2ToUTF8</dd>
|
|
<dt>EncodingCPIso3 ('iso88593')</dt>
|
|
<dd>ISO_8859_3ToUTF8</dd>
|
|
<dt>EncodingCPIso4 ('iso88594')</dt>
|
|
<dd>ISO_8859_4ToUTF8</dd>
|
|
<dt>EncodingCPIso5 ('iso88595')</dt>
|
|
<dd>ISO_8859_5ToUTF8</dd>
|
|
<dt>EncodingCPIso7 ('iso88597')</dt>
|
|
<dd>ISO_8859_7ToUTF8</dd>
|
|
<dt>EncodingCPIso9 ('iso88599')</dt>
|
|
<dd>ISO_8859_9ToUTF8</dd>
|
|
<dt>EncodingCPIso10 ('iso885910')</dt>
|
|
<dd>ISO_8859_9ToUTF10</dd>
|
|
<dt>EncodingCPIso13 ('iso885913')</dt>
|
|
<dd>ISO_8859_9ToUTF13</dd>
|
|
<dt>EncodingCPIso14 ('iso885914')</dt>
|
|
<dd>ISO_8859_14ToUTF8</dd>
|
|
<dt>EncodingCPIso15 ('iso885915')</dt>
|
|
<dd>ISO_8859_15ToUTF8</dd>
|
|
<dt>EncodingCPIso16 ('iso885916')</dt>
|
|
<dd>ISO_8859_16ToUTF8</dd>
|
|
<dt>EncodingCP1250 ('cp1250')</dt>
|
|
<dd>CP1250ToUTF8</dd>
|
|
<dt>EncodingCP1251 ('cp1251')</dt>
|
|
<dd>CP1251ToUTF8</dd>
|
|
<dt>EncodingCP1252 ('cp1252')</dt>
|
|
<dd>CP1252ToUTF8</dd>
|
|
<dt>EncodingCP1253 ('cp1253')</dt>
|
|
<dd>CP1253ToUTF8</dd>
|
|
<dt>EncodingCP1254 ('cp1254')</dt>
|
|
<dd>CP1254ToUTF8</dd>
|
|
<dt>EncodingCP1255 ('cp1255')</dt>
|
|
<dd>CP1255ToUTF8</dd>
|
|
<dt>EncodingCP1256 ('cp1256')</dt>
|
|
<dd>CP1256ToUTF8</dd>
|
|
<dt>EncodingCP1257 ('cp1257')</dt>
|
|
<dd>CP1257ToUTF8</dd>
|
|
<dt>EncodingCP1258 ('cp1258')</dt>
|
|
<dd>CP1258ToUTF8</dd>
|
|
<dt>EncodingCP437 ('cp437')</dt>
|
|
<dd>CP437ToUTF8</dd>
|
|
<dt>EncodingCP850 ('cp850')</dt>
|
|
<dd>CP850ToUTF8</dd>
|
|
<dt>EncodingCP852 ('cp852')</dt>
|
|
<dd>CP852ToUTF8</dd>
|
|
<dt>EncodingCP854 ('cp865')</dt>
|
|
<dd>CP865ToUTF8</dd>
|
|
<dt>EncodingCP866 ('cp866')</dt>
|
|
<dd>CP866ToUTF8</dd>
|
|
<dt>EncodingCP874 ('cp874')</dt>
|
|
<dd>CP874ToUTF8</dd>
|
|
<!-- Asian code pages -->
|
|
<dt>EncodingCP932 ('cp932')</dt>
|
|
<dd>CP932TOUTF8</dd>
|
|
<dt>EncodingCP936 ('cp936')</dt>
|
|
<dd>CP936TOUTF8</dd>
|
|
<dt>EncodingCP949 ('cp949')</dt>
|
|
<dd>CP949TOUTF8</dd>
|
|
<dt>EncodingCP950 ('cp950')</dt>
|
|
<dd>CP950TOUTF8</dd>
|
|
<dt>EncodingCPKOI8R ('koi8r')</dt>
|
|
<dd>KOI8RToUTF8</dd>
|
|
<dt>EncodingCPKOI8U ('koi8u')</dt>
|
|
<dd>KOI8UToUTF8</dd>
|
|
<dt>EncodingCPKOI8RU ('koi8ru')</dt>
|
|
<dd>KOI8RUToUTF8</dd>
|
|
<dt>EncodingCPMac ('macinstosh')</dt>
|
|
<dd>MacintoshToUTF8</dd>
|
|
<dt>EncodingUCS2LE ('ucs2le')</dt>
|
|
<dd>UCS2LEToUTF8</dd>
|
|
<dt>EncodingUCS2BE ('ucs2be')</dt>
|
|
<dd>UCS2BEToUTF8</dd>
|
|
<dt>EncodingAnsi ('ansi') or the default text encoding for the platform</dt>
|
|
<dd>ConvertAnsiToUTF8</dd>
|
|
</dl>
|
|
<p>
|
|
Encoded is a Boolean output parameter which indicates if a routine was found
|
|
to perform the requested conversion. Its value is <b>False</b> when a
|
|
conversion routine was not found for the source encoding in FromEncoding.
|
|
</p>
|
|
<p>
|
|
ConvertEncodingToUTF8 is used in the implementation of the ConvertEncoding
|
|
function.
|
|
</p>
|
|
<remark>
|
|
Conversions to the UTF-8 encoding will always set the code page for the
|
|
converted value to CP_UTF8 (65001). In other words, the SetTargetCodePage
|
|
argument to the ConvertEncoding() function is ignored for conversions to
|
|
UTF-8.
|
|
</remark>
|
|
</descr>
|
|
<seealso>
|
|
<link id="ConvertEncoding"/>
|
|
<link id="ConvertEncodingFromUTF8"/>
|
|
<link id="ConvertAnsiToUTF8"/>
|
|
<link id="NormalizeEncoding"/>
|
|
<link id="GetDefaultTextEncoding"/>
|
|
</seealso>
|
|
</element>
|
|
<element name="ConvertEncodingToUTF8.Result">
|
|
<short>Value for the specified string after encoding conversion.</short>
|
|
</element>
|
|
<element name="ConvertEncodingToUTF8.s">
|
|
<short>String with the encoded value converted to UTF-8.</short>
|
|
</element>
|
|
<element name="ConvertEncodingToUTF8.FromEncoding">
|
|
<short>Encoding name for the value in s.</short>
|
|
</element>
|
|
<element name="ConvertEncodingToUTF8.Encoded">
|
|
<short>
|
|
<b>True</b> if the result contains a multi-byte encoded value. Always
|
|
<b>True</b> for conversions to UTF-8.
|
|
</short>
|
|
</element>
|
|
|
|
<element name="ConvertEncoding">
|
|
<short>
|
|
Converts the specified value from its source encoding to a target encoding
|
|
using an optional code page.
|
|
</short>
|
|
<descr>
|
|
<p>
|
|
ConvertEncoding is a String function used to convert the string specified in
|
|
s from its original encoding name (FromEncoding) to a target encoding
|
|
(ToEncoding).
|
|
</p>
|
|
<p>
|
|
When FromEncoding is omitted, or specified as an empty string (''), UTF-8 is
|
|
used as the original encoding. If the original encoding is ANSI, the default
|
|
text encoding for the platform (GetDefaultTextEncoding) is used as the
|
|
original encoding.
|
|
</p>
|
|
<p>
|
|
Conversely, when ToEncoding is omitted or an empty string, UTF-8 is used as
|
|
the target encoding. If the target encoding is ANSI, the default text
|
|
encoding for the platform (GetDefaultTextEncoding) is used as the target
|
|
encoding.
|
|
</p>
|
|
<p>
|
|
No actions are performed in the routine when FromEncoding and ToEncoding have
|
|
the same values.
|
|
</p>
|
|
<p>
|
|
ConvertEncoding calls ConvertEncodingFromUTF8 to convert the string value
|
|
when the FromEncoding is UTF-8. ConvertEncodingToUTF8 is called when
|
|
ToEncoding is UTF-8. For other encoding conversions, ConvertEncodingToUTF8 is
|
|
called to both get a UTF-8 value which is then converted using
|
|
ConvertEncodingFromUTF8.
|
|
</p>
|
|
<p>
|
|
SetTargetCodePage indicates whether the string with the converted encoding
|
|
should set the code page for the result. The default value for the argument
|
|
is <b>False</b>. The SetTargetCodePage argument is ignored when ToEncoding is
|
|
the UTF-8 encoding ('utf8'). The code page is always set to CP_UTF8 (65001)
|
|
when UTF-8 encoding is used in the result.
|
|
</p>
|
|
<p>
|
|
For platforms where libiconv is enabled, the iconvert routine is used as a
|
|
fallback when an encoding conversion routine was not found.
|
|
</p>
|
|
<p>
|
|
The return value is the original string in s if a transcoding operation is
|
|
not successfully performed (or not needed) for the original string value
|
|
using the specified encodings.
|
|
</p>
|
|
</descr>
|
|
<seealso/>
|
|
</element>
|
|
<element name="ConvertEncoding.Result">
|
|
<short>Value for the specified string after encoding conversion.</short>
|
|
</element>
|
|
<element name="ConvertEncoding.s">
|
|
<short>String value converted in the routine.</short>
|
|
</element>
|
|
<element name="ConvertEncoding.FromEncoding">
|
|
<short>Encoding name for the original string value.</short>
|
|
</element>
|
|
<element name="ConvertEncoding.ToEncoding">
|
|
<short>Encoding name for the converted value.</short>
|
|
</element>
|
|
<element name="ConvertEncoding.SetTargetCodePage">
|
|
<short>
|
|
<b>True</b> if the code page should be set for the converted value. Default
|
|
is <b>False</b>.
|
|
</short>
|
|
</element>
|
|
|
|
<element name="GetDefaultTextEncoding">
|
|
<short>
|
|
Gets the name for the default text encoding used on the platform or operating
|
|
system.
|
|
</short>
|
|
<descr>
|
|
<p>
|
|
GetDefaultTextEncoding gets the default encoding name used for text from the
|
|
DefaultTextEncoding variable (in the unit implementation), when assigned.
|
|
Otherwise, platform-specific routines are used to get return value like:
|
|
GetWindowsEncoding, GetUnixEncoding. The value in the EncodingUTF8 constant
|
|
is used for the Darwin platforms. The return value contains the encoding used
|
|
for AnsiString in the FPC RTL, and is retained in the DefaultTextEncoding
|
|
variable for subsequent calls to the routine.
|
|
</p>
|
|
</descr>
|
|
<seealso>
|
|
<link id="EncodingUTF8"/>
|
|
<link id="NormalizeEncoding"/>
|
|
</seealso>
|
|
</element>
|
|
<element name="GetDefaultTextEncoding.Result">
|
|
<short>The name for the default text encoding used on the platform.</short>
|
|
</element>
|
|
|
|
<element name="GetConsoleTextEncoding">
|
|
<short>
|
|
Gets the encoding used for a console application on the platform.
|
|
</short>
|
|
<descr>
|
|
<p>
|
|
GetConsoleTextEncoding is String function which gets the encoding name used
|
|
for console applications.
|
|
</p>
|
|
<p>
|
|
The return value may differ from the normal system encoding on some Windows
|
|
versions, where the OEM code page is used for a console application. For more
|
|
details, see: <url
|
|
href="https://gitlab.com/freepascal.org/lazarus/lazarus/-/issues/20552">https://gitlab.com/freepascal.org/lazarus/lazarus/-/issues/20552</url>.
|
|
</p>
|
|
<p>
|
|
For all other platforms, the value from GetDefaultTextEncoding is used in the
|
|
return value. The return value is normalized (hyphen characters removed and
|
|
converted to lowercase).
|
|
</p>
|
|
</descr>
|
|
<seealso>
|
|
<link id="GetDefaultTextEncoding"/>
|
|
<link id="NormalizeEncoding"/>
|
|
</seealso>
|
|
</element>
|
|
<element name="GetConsoleTextEncoding.Result">
|
|
<short>Name of the encoding used for text in a console application.</short>
|
|
</element>
|
|
|
|
<element name="NormalizeEncoding">
|
|
<short>
|
|
Converts the specified encoding name to lowercase and removes '-' characters.
|
|
</short>
|
|
<descr>
|
|
<p>
|
|
Converts a value like 'UTF-8' to 'utf8', or 'ISO-8859-1' to 'iso88591'.
|
|
</p>
|
|
<p>
|
|
NormalizeEncoding is used in the implementation of conversion routines, like:
|
|
</p>
|
|
<ul>
|
|
<li>GetDefaultTextEncoding</li>
|
|
<li>GetConsoleTextEncoding</li>
|
|
<li>GuessEncoding</li>
|
|
<li>ConvertEncodingFromUTF8</li>
|
|
<li>ConvertEncodingToUTF8</li>
|
|
<li>ConvertEncoding</li>
|
|
</ul>
|
|
</descr>
|
|
<seealso>
|
|
<link id="GetDefaultTextEncoding"/>
|
|
<link id="GetConsoleTextEncoding"/>
|
|
<link id="GuessEncoding"/>
|
|
<link id="ConvertEncodingFromUTF8"/>
|
|
<link id="ConvertEncodingToUTF8"/>
|
|
<link id="ConvertEncoding"/>
|
|
</seealso>
|
|
</element>
|
|
<element name="NormalizeEncoding.Result">
|
|
<short>
|
|
Contains the encoding name converted to lowercase with hyphen ('-')
|
|
characters removed.
|
|
</short>
|
|
</element>
|
|
<element name="NormalizeEncoding.Encoding">
|
|
<short>Encoding name normalized in the routine.</short>
|
|
</element>
|
|
|
|
<element name="TConvertEncodingFunction">
|
|
<short>
|
|
Specifies a function used to convert a single-byte string value to a specific
|
|
multi-byte encoding.
|
|
</short>
|
|
<descr>
|
|
<p>
|
|
<var>TConvertEncodingFunction</var> is the type used for the
|
|
<var>ConvertAnsiToUTF8</var> variable.
|
|
</p>
|
|
</descr>
|
|
<seealso>
|
|
<link id="ConvertAnsiToUTF8"/>
|
|
<link id="ConvertUTF8ToAnsi"/>
|
|
<link id="TConvertUTF8ToEncodingFunc"/>
|
|
</seealso>
|
|
</element>
|
|
<element name="TConvertEncodingFunction.Result">
|
|
<short>Value after converting the value to the required encoding.</short>
|
|
</element>
|
|
<element name="TConvertEncodingFunction.s">
|
|
<short>Single-byte string value examined and converted in the routine.</short>
|
|
</element>
|
|
|
|
<element name="TConvertUTF8ToEncodingFunc">
|
|
<short>
|
|
Specifies a function used to convert a string value from UTF-8 encoding to
|
|
another encoding with an optional code page.
|
|
</short>
|
|
<descr>
|
|
<p>
|
|
TConvertUTF8ToEncodingFunc is the type used for the ConvertUTF8ToAnsi
|
|
variable in <file>lconvencoding.pas</file>.
|
|
</p>
|
|
</descr>
|
|
<seealso>
|
|
<link id="ConvertUTF8ToAnsi"/>
|
|
</seealso>
|
|
</element>
|
|
<element name="TConvertUTF8ToEncodingFunc.Result">
|
|
<short>
|
|
Value for the string using the code page / encoding implemented in the
|
|
routine.
|
|
</short>
|
|
</element>
|
|
<element name="TConvertUTF8ToEncodingFunc.s">
|
|
<short>UTF-8-encoded string value converted in the routine.</short>
|
|
</element>
|
|
<element name="TConvertUTF8ToEncodingFunc.SetTargetCodePage">
|
|
<short>
|
|
<b>True</b> to set the target code page, <b>False</b> if the code page is not
|
|
needed.
|
|
</short>
|
|
</element>
|
|
|
|
<element name="TCharToUTF8Table">
|
|
<short>
|
|
Alias for the TCharToUTF8Table type in <file>CodepagesCommon.pas</file>.
|
|
</short>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
|
|
<element name="TUnicodeToCharID">
|
|
<short>
|
|
Specifies an Integer function type used to get a character identifier for a
|
|
specific Unicode character.
|
|
</short>
|
|
<descr>
|
|
<p>
|
|
TUnicodeToCharID is the type passed as an argument to conversion routines
|
|
like UTF8ToSingleByte and UTF8ToDBCS.
|
|
</p>
|
|
</descr>
|
|
<seealso>
|
|
<link id="UTF8ToDBCS"/>
|
|
<link id="UTF8ToSingleByte"/>
|
|
</seealso>
|
|
</element>
|
|
<element name="TUnicodeToCharID.Result">
|
|
<short>Integer value for the specified Unicode character.</short>
|
|
</element>
|
|
<element name="TUnicodeToCharID.Unicode">
|
|
<short>
|
|
Cardinal value for the Unicode character converted in the routine.
|
|
</short>
|
|
</element>
|
|
|
|
<element name="ConvertAnsiToUTF8">
|
|
<short>
|
|
Contains the routine used to convert an ANSI string value to UTF-8 encoding.
|
|
</short>
|
|
<descr>
|
|
<p>
|
|
<var>ConvertAnsiToUTF8</var> is a <var>TConvertEncodingFunction</var>
|
|
variable with the routine used to convert a String from its ANSI-encoded
|
|
value to the UTF-8 encoding. A routine which implements the
|
|
TConvertEncodingFunction interface can be assigned to ConvertAnsiToUTF8 to
|
|
handle conversions from the default text encoding, which may use an OEM code
|
|
page, to the UTF-8 encoding.
|
|
</p>
|
|
<p>
|
|
By default, a routine is <b>NOT</b> assigned to ConvertAnsiToUTF8.
|
|
</p>
|
|
<p>
|
|
ConvertAnsiToUTF8 is called (when assigned) from the ConvertEncodingToUTF8
|
|
routine.
|
|
</p>
|
|
</descr>
|
|
<seealso>
|
|
<link id="TConvertEncodingFunction"/>
|
|
<link id="ConvertEncodingToUTF8"/>
|
|
</seealso>
|
|
</element>
|
|
|
|
<element name="ConvertUTF8ToAnsi">
|
|
<short>
|
|
Contains the routine used to convert from UTF-8 encoding to ANSI encoding.
|
|
</short>
|
|
<descr>
|
|
<p>
|
|
ConvertUTF8ToAnsi is a TConvertUTF8ToEncodingFunc variable with the routine
|
|
used to convert a string value from UTF-8 encoding to ANSI encoding. A
|
|
routine which implements the TConvertUTF8ToEncodingFunc interface can be
|
|
assigned to ConvertUTF8ToAnsi to the conversion.
|
|
</p>
|
|
<p>
|
|
The arguments to the routine include the UTF-8-encoded string converted in
|
|
the function, and a boolean argument which indicates if the code page should
|
|
be set for the string in the return value. Set the SetTargetCodePage
|
|
parameter to <b>True</b> to set the code page for the ANSI string in the
|
|
return value. The default value for the argument is <b>False</b>.
|
|
</p>
|
|
<p>
|
|
By default, a routine is <b>NOT</b> assigned to ConvertUTF8ToAnsi.
|
|
</p>
|
|
<p>
|
|
ConvertUTF8ToAnsi is called (when assigned) from the ConvertEncodingFromUTF8
|
|
routine.
|
|
</p>
|
|
</descr>
|
|
<seealso>
|
|
<link id="TConvertUTF8ToEncodingFunc"/>
|
|
<link id="ConvertEncodingFromUTF8"/>
|
|
</seealso>
|
|
</element>
|
|
|
|
<element name="UTF8BOMToUTF8">
|
|
<short>Removes the UTF-8 BOM from the UTF-8 encoded value.</short>
|
|
<descr>
|
|
<p>
|
|
The return value is the value in <var>s</var> after removing the Byte Order
|
|
Mark in <var>UTF8BOM</var> from the start of the string. The return value is
|
|
the same as the value in s when UTF8BOM is not found in the string.
|
|
</p>
|
|
<p>
|
|
No actions are performed in the routine when <var>s</var> is an empty string
|
|
(<b>''</b>). The return value is also an empty string.
|
|
</p>
|
|
</descr>
|
|
<seealso/>
|
|
</element>
|
|
<element name="UTF8BOMToUTF8.Result">
|
|
<short>Value after removing the UTF-8 BOM.</short>
|
|
</element>
|
|
<element name="UTF8BOMToUTF8.s">
|
|
<short>UTF-8-encoded value examined in the routine.</short>
|
|
</element>
|
|
|
|
<element name="ISO_8859_1ToUTF8">
|
|
<short>Converts an ISO 8859-1-encoded string to UTF-8.</short>
|
|
<descr>
|
|
<p>
|
|
Calls SingleByteToUTF8 to convert the specified string using the character
|
|
translation array in ArrayISO_8859_1ToUTF8.
|
|
</p>
|
|
</descr>
|
|
<seealso/>
|
|
</element>
|
|
<element name="ISO_8859_1ToUTF8.Result">
|
|
<short>UTF-8-encoded value for the specified string.</short>
|
|
</element>
|
|
<element name="ISO_8859_1ToUTF8.s">
|
|
<short>String with the value in ISO 8859-1 encoding.</short>
|
|
</element>
|
|
|
|
<element name="ISO_8859_14ToUTF8">
|
|
<short>Converts an ISO 8859-14-encoded string to UTF-8 encoding.</short>
|
|
<descr>
|
|
<p>
|
|
Calls SingleByteToUTF8 to convert the specified string using the character
|
|
translation array in ArrayISO_8859_14ToUTF8.
|
|
</p>
|
|
</descr>
|
|
<seealso/>
|
|
</element>
|
|
<element name="ISO_8859_14ToUTF8.Result">
|
|
<short>UTF-8-encoded value for the specified string.</short>
|
|
</element>
|
|
<element name="ISO_8859_14ToUTF8.s">
|
|
<short>String with the value in ISO 8859-14 encoding.</short>
|
|
</element>
|
|
|
|
<element name="ISO_8859_15ToUTF8">
|
|
<short>Converts an ISO 8859-15-encoded string to UTF-8.</short>
|
|
<descr>
|
|
<p>
|
|
Calls SingleByteToUTF8 to convert the specified string using the character
|
|
translation array in ArrayISO_8859_15ToUTF8.
|
|
</p>
|
|
</descr>
|
|
<seealso/>
|
|
</element>
|
|
<element name="ISO_8859_15ToUTF8.Result">
|
|
<short>UTF-8-encoded value for the specified string.</short>
|
|
</element>
|
|
<element name="ISO_8859_15ToUTF8.s">
|
|
<short>String with the value in ISO 8859-15 encoding.</short>
|
|
</element>
|
|
|
|
<element name="ISO_8859_16ToUTF8">
|
|
<short>Converts an ISO 8859-16-encoded string to UTF-8.</short>
|
|
<descr>
|
|
<p>
|
|
Calls SingleByteToUTF8 to convert the specified string using the character
|
|
translation array in ArrayISO_8859_16ToUTF8.
|
|
</p>
|
|
</descr>
|
|
<seealso/>
|
|
</element>
|
|
<element name="ISO_8859_16ToUTF8.Result">
|
|
<short>UTF-8-encoded value for the specified string.</short>
|
|
</element>
|
|
<element name="ISO_8859_16ToUTF8.s">
|
|
<short>String with the value in ISO 8859-16 encoding.</short>
|
|
</element>
|
|
|
|
<element name="ISO_8859_2ToUTF8">
|
|
<short>Converts an ISO 8859-2-encoded string to UTF-8.</short>
|
|
<descr>
|
|
<p>
|
|
Calls SingleByteToUTF8 to convert the specified string using the character
|
|
translation array in ArrayISO_8859_2ToUTF8.
|
|
</p>
|
|
</descr>
|
|
<seealso/>
|
|
</element>
|
|
<element name="ISO_8859_2ToUTF8.Result">
|
|
<short>UTF-8-encoded value for the specified string.</short>
|
|
</element>
|
|
<element name="ISO_8859_2ToUTF8.s">
|
|
<short>String with the value in ISO 8859-2 encoding.</short>
|
|
</element>
|
|
|
|
<element name="ISO_8859_3ToUTF8">
|
|
<short>Converts an ISO 8859-3-encoded string to UTF-8.</short>
|
|
<descr>
|
|
<p>
|
|
Calls SingleByteToUTF8 to convert the specified string using the character
|
|
translation array in ArrayISO_8859_3ToUTF8.
|
|
</p>
|
|
</descr>
|
|
<seealso/>
|
|
</element>
|
|
<element name="ISO_8859_3ToUTF8.Result">
|
|
<short>UTF-8-encoded value for the specified string.</short>
|
|
</element>
|
|
<element name="ISO_8859_3ToUTF8.s">
|
|
<short>String with the value in ISO 8859-3 encoding.</short>
|
|
</element>
|
|
|
|
<element name="ISO_8859_4ToUTF8">
|
|
<short>Converts an ISO 8859-4-encoded string to UTF-8.</short>
|
|
<descr>
|
|
<p>
|
|
Calls SingleByteToUTF8 to convert the specified string using the character
|
|
translation array in ArrayISO_8859_4ToUTF8.
|
|
</p>
|
|
</descr>
|
|
<seealso/>
|
|
</element>
|
|
<element name="ISO_8859_4ToUTF8.Result">
|
|
<short>UTF-8-encoded value for the specified string.</short>
|
|
</element>
|
|
<element name="ISO_8859_4ToUTF8.s">
|
|
<short>String with the value in ISO 8859-4 encoding.</short>
|
|
</element>
|
|
|
|
<element name="ISO_8859_5ToUTF8">
|
|
<short>Converts an ISO 8859-5-encoded string to UTF-8.</short>
|
|
<descr>
|
|
<p>
|
|
Calls SingleByteToUTF8 to convert the specified string using the character
|
|
translation array in ArrayISO_8859_5ToUTF8.
|
|
</p>
|
|
</descr>
|
|
<seealso/>
|
|
</element>
|
|
<element name="ISO_8859_5ToUTF8.Result">
|
|
<short>UTF-8-encoded value for the specified string.</short>
|
|
</element>
|
|
<element name="ISO_8859_5ToUTF8.s">
|
|
<short>String with the value in ISO 8859-5 encoding.</short>
|
|
</element>
|
|
|
|
<element name="ISO_8859_7ToUTF8">
|
|
<short>Converts an ISO 8859-7-encoded string to UTF-8.</short>
|
|
<descr>
|
|
<p>
|
|
Calls SingleByteToUTF8 to convert the specified string using the character
|
|
translation array in ArrayISO_8859_7ToUTF8.
|
|
</p>
|
|
</descr>
|
|
<seealso/>
|
|
</element>
|
|
<element name="ISO_8859_7ToUTF8.Result">
|
|
<short>UTF-8-encoded value for the specified string.</short>
|
|
</element>
|
|
<element name="ISO_8859_7ToUTF8.s">
|
|
<short>String with the value in ISO 8859-5 encoding.</short>
|
|
</element>
|
|
|
|
<element name="ISO_8859_9ToUTF8">
|
|
<short>
|
|
Converts a string from its ISO 8859-9 (Turkish) encoding to UTF-8 encoding.
|
|
</short>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<element name="ISO_8859_9ToUTF8.Result">
|
|
<short>UTF-8-encoded value for the specified string.</short>
|
|
</element>
|
|
<element name="ISO_8859_9ToUTF8.s">
|
|
<short>String with the value in ISO 8859-9 encoding.</short>
|
|
</element>
|
|
|
|
<element name="ISO_8859_10ToUTF8">
|
|
<short>
|
|
Converts a string from its ISO 8859-10 (Latin-6) encoding to UTF-8 encoding.
|
|
</short>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<element name="ISO_8859_10ToUTF8.Result">
|
|
<short>UTF-8-encoded value for the specified string.</short>
|
|
</element>
|
|
<element name="ISO_8859_10ToUTF8.s">
|
|
<short>String with the value in ISO 8859-10 encoding.</short>
|
|
</element>
|
|
|
|
<element name="ISO_8859_13ToUTF8">
|
|
<short>
|
|
Converts a string from its ISO 8859-13 (Latin-7) encoding to UTF-8 encoding.
|
|
</short>
|
|
<descr/>
|
|
<seealso/>
|
|
</element>
|
|
<element name="ISO_8859_13ToUTF8.Result">
|
|
<short>UTF-8-encoded value for the specified string.</short>
|
|
</element>
|
|
<element name="ISO_8859_13ToUTF8.s">
|
|
<short>String with the value in ISO 8859-10 encoding.</short>
|
|
</element>
|
|
|
|
<element name="CP1250ToUTF8">
|
|
<short>Converts a Code Page 1250-encoded string to UTF-8.</short>
|
|
<descr>
|
|
<p>
|
|
Calls SingleByteToUTF8 to convert the specified string using the character
|
|
translation array in ArrayCP1250ToUTF8.
|
|
</p>
|
|
</descr>
|
|
<seealso/>
|
|
</element>
|
|
<element name="CP1250ToUTF8.Result">
|
|
<short>UTF-8-encoded value for the specified string.</short>
|
|
</element>
|
|
<element name="CP1250ToUTF8.s">
|
|
<short>String with the value in Code Page 1250 encoding.</short>
|
|
</element>
|
|
|
|
<element name="CP1251ToUTF8">
|
|
<short>Converts a Code Page 1251-encoded value to UTF-8.</short>
|
|
<descr>
|
|
<p>
|
|
Calls SingleByteToUTF8 to convert the specified string using the character
|
|
translation array in ArrayCP1251ToUTF8.
|
|
</p>
|
|
</descr>
|
|
<seealso/>
|
|
</element>
|
|
<element name="CP1251ToUTF8.Result">
|
|
<short>UTF-8-encoded value for the specified string.</short>
|
|
</element>
|
|
<element name="CP1251ToUTF8.s">
|
|
<short>String with the value in Code Page 1251 encoding.</short>
|
|
</element>
|
|
|
|
<element name="CP1252ToUTF8">
|
|
<short>Converts a Code Page 1252-encoded value to UTF-8.</short>
|
|
<descr>
|
|
<p>
|
|
Calls SingleByteToUTF8 to convert the specified string using the character
|
|
translation array in ArrayCP1252ToUTF8.
|
|
</p>
|
|
</descr>
|
|
<seealso/>
|
|
</element>
|
|
<element name="CP1252ToUTF8.Result">
|
|
<short>UTF-8-encoded value for the specified string.</short>
|
|
</element>
|
|
<element name="CP1252ToUTF8.s">
|
|
<short>String with the value in Code Page 1252 encoding.</short>
|
|
</element>
|
|
|
|
<element name="CP1253ToUTF8">
|
|
<short>Converts a Code Page 1253-encoded value to UTF-8.</short>
|
|
<descr>
|
|
<p>
|
|
Calls SingleByteToUTF8 to convert the specified string using the character
|
|
translation array in ArrayCP1253ToUTF8.
|
|
</p>
|
|
</descr>
|
|
<seealso/>
|
|
</element>
|
|
<element name="CP1253ToUTF8.Result">
|
|
<short>UTF-8-encoded value for the specified string.</short>
|
|
</element>
|
|
<element name="CP1253ToUTF8.s">
|
|
<short>String with the value in Code Page 1253 encoding.</short>
|
|
</element>
|
|
|
|
<element name="CP1254ToUTF8">
|
|
<short>Converts a Code Page 1254-encoded value to UTF-8.</short>
|
|
<descr>
|
|
<p>
|
|
Calls SingleByteToUTF8 to convert the specified string using the character
|
|
translation array in ArrayCP1254ToUTF8.
|
|
</p>
|
|
</descr>
|
|
<seealso/>
|
|
</element>
|
|
<element name="CP1254ToUTF8.Result">
|
|
<short>UTF-8-encoded value for the specified string.</short>
|
|
</element>
|
|
<element name="CP1254ToUTF8.s">
|
|
<short>String with the value in Code Page 1254 encoding.</short>
|
|
</element>
|
|
|
|
<element name="CP1255ToUTF8">
|
|
<short>Converts a Code Page 1255-encoded value to UTF-8.</short>
|
|
<descr>
|
|
<p>
|
|
Calls SingleByteToUTF8 to convert the specified string using the character
|
|
translation array in ArrayCP1255ToUTF8.
|
|
</p>
|
|
</descr>
|
|
<seealso/>
|
|
</element>
|
|
<element name="CP1255ToUTF8.Result">
|
|
<short>UTF-8-encoded value for the specified string.</short>
|
|
</element>
|
|
<element name="CP1255ToUTF8.s">
|
|
<short>String with the value in Code Page 1255 encoding.</short>
|
|
</element>
|
|
|
|
<element name="CP1256ToUTF8">
|
|
<short>Converts a Code Page 1256-encoded value to UTF-8.</short>
|
|
<descr>
|
|
<p>
|
|
Calls SingleByteToUTF8 to convert the specified string using the character
|
|
translation array in ArrayCP1256ToUTF8.
|
|
</p>
|
|
</descr>
|
|
<seealso/>
|
|
</element>
|
|
<element name="CP1256ToUTF8.Result">
|
|
<short>UTF-8-encoded value for the specified string.</short>
|
|
</element>
|
|
<element name="CP1256ToUTF8.s">
|
|
<short>String with the value in Code Page 1256 encoding.</short>
|
|
</element>
|
|
|
|
<element name="CP1257ToUTF8">
|
|
<short>Converts a Code Page 1257-encoded value to UTF-8.</short>
|
|
<descr>
|
|
<p>
|
|
Calls SingleByteToUTF8 to convert the specified string using the character
|
|
translation array in ArrayCP1257ToUTF8.
|
|
</p>
|
|
</descr>
|
|
<seealso/>
|
|
</element>
|
|
<element name="CP1257ToUTF8.Result">
|
|
<short>UTF-8-encoded value for the specified string.</short>
|
|
</element>
|
|
<element name="CP1257ToUTF8.s">
|
|
<short>String with the value in Code Page 1257 encoding.</short>
|
|
</element>
|
|
|
|
<element name="CP1258ToUTF8">
|
|
<short>Converts a Code Page 1258-encoded value to UTF-8.</short>
|
|
<descr>
|
|
<p>
|
|
Calls SingleByteToUTF8 to convert the specified string using the character
|
|
translation array in ArrayCP1258ToUTF8.
|
|
</p>
|
|
</descr>
|
|
<seealso/>
|
|
</element>
|
|
<element name="CP1258ToUTF8.Result">
|
|
<short>UTF-8-encoded value for the specified string.</short>
|
|
</element>
|
|
<element name="CP1258ToUTF8.s">
|
|
<short>String with the value in Code Page 1258 encoding.</short>
|
|
</element>
|
|
|
|
<element name="CP437ToUTF8">
|
|
<short>Converts a Code Page 437-encoded value to UTF-8.</short>
|
|
<descr>
|
|
<p>
|
|
Calls SingleByteToUTF8 to convert the specified string using the character
|
|
translation array in ArrayCP437ToUTF8.
|
|
</p>
|
|
</descr>
|
|
<seealso/>
|
|
</element>
|
|
<element name="CP437ToUTF8.Result">
|
|
<short>UTF-8-encoded value for the specified string.</short>
|
|
</element>
|
|
<element name="CP437ToUTF8.s">
|
|
<short>String with the value in Code Page 437 encoding.</short>
|
|
</element>
|
|
|
|
<element name="CP850ToUTF8">
|
|
<short>Converts a Code Page 850-encoded value to UTF-8.</short>
|
|
<descr>
|
|
<p>
|
|
Calls SingleByteToUTF8 to convert the specified string using the character
|
|
translation array in ArrayCP850ToUTF8.
|
|
</p>
|
|
</descr>
|
|
<seealso/>
|
|
</element>
|
|
<element name="CP850ToUTF8.Result">
|
|
<short>UTF-8-encoded value for the specified string.</short>
|
|
</element>
|
|
<element name="CP850ToUTF8.s">
|
|
<short>String with the value in Code Page 850 encoding.</short>
|
|
</element>
|
|
|
|
<element name="CP852ToUTF8">
|
|
<short>Converts a Code Page 852-encoded value to UTF-8.</short>
|
|
<descr>
|
|
<p>
|
|
Calls SingleByteToUTF8 to convert the specified string using the character
|
|
translation array in ArrayCP852ToUTF8.
|
|
</p>
|
|
</descr>
|
|
<seealso/>
|
|
</element>
|
|
<element name="CP852ToUTF8.Result">
|
|
<short>UTF-8-encoded value for the specified string.</short>
|
|
</element>
|
|
<element name="CP852ToUTF8.s">
|
|
<short>String with the value in Code Page 852 encoding.</short>
|
|
</element>
|
|
|
|
<element name="CP865ToUTF8">
|
|
<short>Converts a Code Page 852-encoded value to UTF-8.</short>
|
|
<descr>
|
|
<p>
|
|
Calls SingleByteToUTF8 to convert the specified string using the character
|
|
translation array in ArrayCP865ToUTF8.
|
|
</p>
|
|
</descr>
|
|
<seealso/>
|
|
</element>
|
|
<element name="CP865ToUTF8.Result">
|
|
<short>UTF-8-encoded value for the specified string.</short>
|
|
</element>
|
|
<element name="CP865ToUTF8.s">
|
|
<short>String with the value in Code Page 865 encoding.</short>
|
|
</element>
|
|
|
|
<element name="CP866ToUTF8">
|
|
<short>Converts a Code Page 866-encoded value to UTF-8.</short>
|
|
<descr>
|
|
<p>
|
|
Calls SingleByteToUTF8 to convert the specified string using the character
|
|
translation array in ArrayCP866ToUTF8.
|
|
</p>
|
|
</descr>
|
|
<seealso/>
|
|
</element>
|
|
<element name="CP866ToUTF8.Result">
|
|
<short>UTF-8-encoded value for the specified string.</short>
|
|
</element>
|
|
<element name="CP866ToUTF8.s">
|
|
<short>String with the value in Code Page 866 encoding.</short>
|
|
</element>
|
|
|
|
<element name="CP874ToUTF8">
|
|
<short>Converts a Code Page 874-encoded value to UTF-8.</short>
|
|
<descr>
|
|
<p>
|
|
Calls SingleByteToUTF8 to convert the specified string using the character
|
|
translation array in ArrayCP874ToUTF8.
|
|
</p>
|
|
</descr>
|
|
<seealso/>
|
|
</element>
|
|
<element name="CP874ToUTF8.Result">
|
|
<short>UTF-8-encoded value for the specified string.</short>
|
|
</element>
|
|
<element name="CP874ToUTF8.s">
|
|
<short>String with the value in Code Page 874 encoding.</short>
|
|
</element>
|
|
|
|
<element name="KOI8RToUTF8">
|
|
<short>Converts a KOI8-R-encoded value to UTF-8.</short>
|
|
<descr>
|
|
<p>
|
|
Calls SingleByteToUTF8 to convert the specified string using the character
|
|
translation array in ArrayKOI8RToUTF8.
|
|
</p>
|
|
</descr>
|
|
<seealso/>
|
|
</element>
|
|
<element name="KOI8RToUTF8.Result">
|
|
<short>UTF-8-encoded value for the specified string.</short>
|
|
</element>
|
|
<element name="KOI8RToUTF8.s">
|
|
<short>String with the value in the KOI8R encoding.</short>
|
|
</element>
|
|
|
|
<element name="MacintoshToUTF8">
|
|
<short>
|
|
Converts a value encoded using the Macintosh Code Page to UTF-8.
|
|
</short>
|
|
<descr>
|
|
<p>
|
|
Calls SingleByteToUTF8 to convert the specified string using the character
|
|
translation array in ArrayMacintoshToUTF8.
|
|
</p>
|
|
</descr>
|
|
<seealso/>
|
|
</element>
|
|
<element name="MacintoshToUTF8.Result">
|
|
<short>UTF-8-encoded value for the specified string.</short>
|
|
</element>
|
|
<element name="MacintoshToUTF8.s">
|
|
<short>String with the value in the Macintosh Roman encoding.</short>
|
|
</element>
|
|
|
|
<element name="SingleByteToUTF8">
|
|
<short>
|
|
Converts a string with single-byte values to UTF-8 using a character
|
|
translation array.
|
|
</short>
|
|
<descr>
|
|
<p>
|
|
s is the string, in its single-byte encoding, with the character values
|
|
converted in the routine.
|
|
</p>
|
|
<p>
|
|
Table is a TCharToUTF8Table type and contains an array with the multi-byte
|
|
values for each of the character using the UTF-8 encoding. The array has 256
|
|
elements representing #0 and each of the decimal values in the single byte
|
|
character set, and may contain 1-4 byte values as needed for the UTF-8
|
|
encoding.
|
|
</p>
|
|
<p>
|
|
SingleByteToUTF8 iterates over the character values in s, and converts each
|
|
single-byte character to the multi-byte value at the corresponding ordinal
|
|
position in Table. If s is an empty string (''), the return value is also an
|
|
empty string.
|
|
</p>
|
|
<p>
|
|
The return value is cast to a RawByteString type, and its code page is set to
|
|
CP_UTF8 (65001).
|
|
</p>
|
|
</descr>
|
|
<seealso>
|
|
<link id="TCharToUTF8Table"/>
|
|
<link id="#lazutils.codepagescommon.ArrayISO_8859_1ToUTF8">ArrayISO_8859_1ToUTF8</link>
|
|
<link id="#lazutils.codepagescommon.ArrayISO_8859_2ToUTF8">ArrayISO_8859_2ToUTF8</link>
|
|
<link id="#lazutils.codepagescommon.ArrayISO_8859_15ToUTF8">ArrayISO_8859_14ToUTF8</link>
|
|
<link id="#lazutils.codepagescommon.ArrayISO_8859_15ToUTF8">ArrayISO_8859_15ToUTF8</link>
|
|
<link id="#lazutils.codepagescommon.ArrayCP1250ToUTF8">ArrayCP1250ToUTF8</link>
|
|
<link id="#lazutils.codepagescommon.ArrayCP1251ToUTF8">ArrayCP1251ToUTF8</link>
|
|
<link id="#lazutils.codepagescommon.ArrayCP1252ToUTF8">ArrayCP1252ToUTF8</link>
|
|
<link id="#lazutils.codepagescommon.ArrayCP1253ToUTF8">ArrayCP1253ToUTF8</link>
|
|
<link id="#lazutils.codepagescommon.ArrayCP1254ToUTF8">ArrayCP1254ToUTF8</link>
|
|
<link id="#lazutils.codepagescommon.ArrayCP1255ToUTF8">ArrayCP1255ToUTF8</link>
|
|
<link id="#lazutils.codepagescommon.ArrayCP1255ToUTF8">ArrayCP1255ToUTF8</link>
|
|
<link id="#lazutils.codepagescommon.ArrayCP1257ToUTF8">ArrayCP1257ToUTF8</link>
|
|
<link id="#lazutils.codepagescommon.ArrayCP437ToUTF8">ArrayCP437ToUTF8</link>
|
|
<link id="#lazutils.codepagescommon.ArrayCP850ToUTF8">ArrayCP850ToUTF8</link>
|
|
<link id="#lazutils.codepagescommon.ArrayCP866ToUTF8">ArrayCP866ToUTF8</link>
|
|
<link id="#lazutils.codepagescommon.ArrayKOI8RToUTF8">ArrayKOI8RToUTF8</link>
|
|
<link id="#lazutils.codepagescommon.ArrayKOI8UToUTF8">ArrayKOI8UToUTF8</link>
|
|
<link id="#lazutils.codepagescommon.ArrayMacintoshToUTF8">ArrayMacintoshToUTF8</link>
|
|
</seealso>
|
|
</element>
|
|
<element name="SingleByteToUTF8.Result">
|
|
<short>String with the UTF-8-encoded value, or an empty string.</short>
|
|
</element>
|
|
<element name="SingleByteToUTF8.s">
|
|
<short>String with the single-byte values converted in the routine.</short>
|
|
</element>
|
|
<element name="SingleByteToUTF8.Table">
|
|
<short>Table with Character to PChar mappings for the converted value.</short>
|
|
</element>
|
|
|
|
<element name="UCS2LEToUTF8">
|
|
<short>Converts a string from UCS 2-byte LE encoding to UTF-8.</short>
|
|
<descr>
|
|
<p>
|
|
<var>UCS2LEToUTF8</var> is a <var>String</var> function used to convert a
|
|
value encoded using UCS2 LE (Little Endian) to its UTF-8 encoding. UCS2 is a
|
|
fixed-length encoding where each character is represented using 2 bytes
|
|
(16-bits). Byte values are stored in Least Significant (Little Endian) byte
|
|
order.
|
|
</p>
|
|
<p>
|
|
UCS2LEToUTF8 iterates over the characters in the string value, and converts
|
|
each character to the variable length multi-byte encoding used for characters
|
|
in UTF-8. LEToN is called to convert the byte values to the byte order used
|
|
for the platform. The UnicodeToUTF8SkipErrors routine in
|
|
<file>lazutf8.pas</file> is called to handle code points which are malformed,
|
|
require translation or are not used in UTF-8.
|
|
</p>
|
|
<p>
|
|
An exception is raised in UCS2LEToUTF8 if the length of the converted string
|
|
is longer than 1.5 times the original string length.
|
|
</p>
|
|
<p>
|
|
The return value is cast to a RawByteString type, and SetCodePage is called
|
|
to set the code page to CP_UTF8 (65001) in the result.
|
|
</p>
|
|
<p>
|
|
No actions are performed in the routine when s is an empty string (''), and
|
|
the return value is an empty string.
|
|
</p>
|
|
</descr>
|
|
<seealso>
|
|
<link id="#lazutils.lazutf8.UnicodeToUTF8SkipErrors">UnicodeToUTF8SkipErrors</link>
|
|
<link id="#rtl.system.SetCodePage">SetCodePage</link>
|
|
<link id="#rtl.system.LEToN">LEToN</link>
|
|
</seealso>
|
|
</element>
|
|
<element name="UCS2LEToUTF8.Result">
|
|
<short>String value after conversion to UTF-8 encoding.</short>
|
|
</element>
|
|
<element name="UCS2LEToUTF8.s">
|
|
<short>String value using UCS2 LE encoding.</short>
|
|
</element>
|
|
|
|
<element name="UCS2BEToUTF8">
|
|
<short>Converts a string from UCS 2-byte BE encoding to UTF-8.</short>
|
|
<descr>
|
|
<p>
|
|
<var>UCS2BEToUTF8</var> is a <var>String</var> function used to convert a
|
|
value encoded using UCS2 BE (Big Endian) to its UTF-8 encoding. UCS2 is a
|
|
fixed-length encoding where each character is represented using 2 bytes
|
|
(16-bits). Byte values are stored in Most Significant (Big Endian) byte order.
|
|
</p>
|
|
<p>
|
|
UCS2BEToUTF8 iterates over the characters in the string value, and converts
|
|
each character to the variable length multi-byte encoding used for characters
|
|
in UTF-8. BEToN is called to convert the byte values to the byte order used
|
|
for the platform. The UnicodeToUTF8SkipErrors routine in
|
|
<file>lazutf8.pas</file> is called to handle code points which are malformed,
|
|
require translation or are not used in UTF-8.
|
|
</p>
|
|
<p>
|
|
An exception is raised in UCS2BEToUTF8 if the length of the converted string
|
|
is longer than 1.5 times the original string length.
|
|
</p>
|
|
<p>
|
|
The return value is cast to a RawByteString type, and SetCodePage is called
|
|
to set the code page to CP_UTF8 (65001) in the result.
|
|
</p>
|
|
<p>
|
|
No actions are performed in the routine when s is an empty string (''), and
|
|
the return value is an empty string.
|
|
</p>
|
|
</descr>
|
|
<seealso>
|
|
<link id="#lazutils.lazutf8.UnicodeToUTF8SkipErrors">UnicodeToUTF8SkipErrors</link>
|
|
<link id="#rtl.system.SetCodePage">SetCodePage</link>
|
|
<link id="#rtl.system.BEToN">BEToN</link>
|
|
</seealso>
|
|
</element>
|
|
<element name="UCS2BEToUTF8.Result">
|
|
<short>String value after conversion to UTF-8 encoding.</short>
|
|
</element>
|
|
<element name="UCS2BEToUTF8.s">
|
|
<short>String value using UCS2 BE encoding.</short>
|
|
</element>
|
|
|
|
<element name="UTF8ToUTF8BOM">
|
|
<short>
|
|
Converts a string from UTF-8 encoding to UTF-8 with a Byte Order Mark.
|
|
</short>
|
|
<descr>
|
|
<p>
|
|
UTF8ToUTF8BOM simply prepends the byte values in UTF8BOM to the value passed
|
|
in the s argument. No actual encoding conversion is required. The return
|
|
value contains the concatenated values.
|
|
</p>
|
|
</descr>
|
|
<seealso>
|
|
<link id="UTF8BOM"/>
|
|
</seealso>
|
|
</element>
|
|
<element name="UTF8ToUTF8BOM.Result">
|
|
<short>
|
|
UTF-8-encoded string value after the BOM is inserted at the beginning of the
|
|
string.
|
|
</short>
|
|
</element>
|
|
<element name="UTF8ToUTF8BOM.s">
|
|
<short>UTF8-encoded string value updated in the routine.</short>
|
|
</element>
|
|
|
|
<element name="UTF8ToISO_8859_1">
|
|
<short>Converts a string from UTF-8 encoding to ISO 8859-1.</short>
|
|
<descr>
|
|
<p>
|
|
<var>UTF8ToISO_8859_1</var> is a <var>RawByteString</var> function used to
|
|
convert a UTF-8-encoded string to the ISO 8859-1 (Central European) encoding.
|
|
</p>
|
|
<p>
|
|
For platforms where system code pages are enabled, SetCodePage is called to
|
|
convert the value to the ISO 8859-1 code page (28591). If SetTargetCodePage
|
|
is <b>False</b>, SetCodePage is called again to apply the CP_ACP (ANSI) code
|
|
page in the return value.
|
|
</p>
|
|
<p>
|
|
For other platforms, the UTF8ToSingleByte routine is called using
|
|
UnicodeToISO_8859_1 to perform character conversions needed for the target
|
|
encoding.
|
|
</p>
|
|
<p>
|
|
UTF8ToISO_8859_1 is used in the implementation of the ConvertEncodingFromUTF8
|
|
encoding conversion routine.
|
|
</p>
|
|
</descr>
|
|
<seealso>
|
|
<link id="ConvertEncodingFromUTF8"/>
|
|
<link id="UTF8ToSingleByte"/>
|
|
<link id="#rtl.system.SetCodePage">SetCodePage</link>
|
|
</seealso>
|
|
</element>
|
|
<element name="UTF8ToISO_8859_1.Result">
|
|
<short>String value after conversion to ISO 8859-1.</short>
|
|
</element>
|
|
<element name="UTF8ToISO_8859_1.s">
|
|
<short>UTF-8-encoded string value converted in the routine.</short>
|
|
</element>
|
|
<element name="UTF8ToISO_8859_1.SetTargetCodePage">
|
|
<short>
|
|
<b>True</b> if the target code page is set in the return value, <b>False</b>
|
|
if the default system code page (CP_ACP) is used.
|
|
</short>
|
|
</element>
|
|
|
|
<element name="UTF8ToISO_8859_14">
|
|
<short>Converts a string from UTF-8 encoding to ISO 8859-14.</short>
|
|
<descr>
|
|
<p>
|
|
<var>UTF8ToISO_8859_14</var> is a <var>RawByteString</var> function used to
|
|
convert a UTF-8-encoded string to the ISO 8859-14 (Latin-8 / Celtic) encoding.
|
|
</p>
|
|
<p>
|
|
For platforms where system code pages are enabled, SetCodePage is called to
|
|
convert the value to the ISO 8859-14 code page (28604). If SetTargetCodePage
|
|
is <b>False</b>, SetCodePage is called again to apply the CP_ACP (ANSI) code
|
|
page in the return value.
|
|
</p>
|
|
<p>
|
|
For other platforms, the UTF8ToSingleByte routine is called using
|
|
UnicodeToISO_8859_14 to perform character conversions needed for the target
|
|
encoding.
|
|
</p>
|
|
<p>
|
|
UTF8ToISO_8859_14 is used in the implementation of the
|
|
ConvertEncodingFromUTF8 encoding conversion routine.
|
|
</p>
|
|
</descr>
|
|
<seealso>
|
|
<link id="ConvertEncodingFromUTF8"/>
|
|
<link id="UTF8ToSingleByte"/>
|
|
<link id="#rtl.system.SetCodePage">SetCodePage</link>
|
|
</seealso>
|
|
</element>
|
|
<element name="UTF8ToISO_8859_14.Result">
|
|
<short>String value after conversion to ISO 8859-14.</short>
|
|
</element>
|
|
<element name="UTF8ToISO_8859_14.s">
|
|
<short>UTF-8-encoded string value converted in the routine.</short>
|
|
</element>
|
|
<element name="UTF8ToISO_8859_14.SetTargetCodePage">
|
|
<short>
|
|
<b>True</b> if the target code page is set in the return value, <b>False</b>
|
|
if the default system code page (CP_ACP) is used.
|
|
</short>
|
|
</element>
|
|
|
|
<element name="UTF8ToISO_8859_15">
|
|
<short>Converts a string from UTF-8 encoding to ISO 8859-15.</short>
|
|
<descr>
|
|
<p>
|
|
<var>UTF8ToISO_8859_15</var> is a <var>RawByteString</var> function used to
|
|
convert a UTF-8-encoded string to the ISO 8859-15 (Western European) encoding.
|
|
</p>
|
|
<p>
|
|
For platforms where system code pages are enabled, SetCodePage is called to
|
|
convert the value to the ISO 8859-15 code page (28605). If SetTargetCodePage
|
|
is <b>False</b>, SetCodePage is called again to apply the CP_ACP (ANSI) code
|
|
page in the return value.
|
|
</p>
|
|
<p>
|
|
For other platforms, the UTF8ToSingleByte routine is called using
|
|
UnicodeToISO_8859_15 to perform character conversions needed for the target
|
|
encoding.
|
|
</p>
|
|
<p>
|
|
UTF8ToISO_8859_15 is used in the implementation of the
|
|
ConvertEncodingFromUTF8 encoding conversion routine.
|
|
</p>
|
|
</descr>
|
|
<seealso>
|
|
<link id="ConvertEncodingFromUTF8"/>
|
|
<link id="UTF8ToSingleByte"/>
|
|
<link id="#rtl.system.SetCodePage">SetCodePage</link>
|
|
</seealso>
|
|
</element>
|
|
<element name="UTF8ToISO_8859_15.Result">
|
|
<short>String value after conversion to ISO 8859-15.</short>
|
|
</element>
|
|
<element name="UTF8ToISO_8859_15.s">
|
|
<short>UTF-8-encoded string value converted in the routine.</short>
|
|
</element>
|
|
<element name="UTF8ToISO_8859_15.SetTargetCodePage">
|
|
<short>
|
|
<b>True</b> if the target code page is set in the return value, <b>False</b>
|
|
if the default system code page (CP_ACP) is used.
|
|
</short>
|
|
</element>
|
|
|
|
<element name="UTF8ToISO_8859_16">
|
|
<short>Converts a string from UTF-8 encoding to ISO 8859-16.</short>
|
|
<descr>
|
|
<p>
|
|
<var>UTF8ToISO_8859_16</var> is a <var>RawByteString</var> function used to
|
|
convert a UTF-8-encoded string to the ISO 8859-16 (Latin-10 or South-Eastern
|
|
European) encoding.
|
|
</p>
|
|
<p>
|
|
For platforms where system code pages are enabled, SetCodePage is called to
|
|
convert the value to the ISO 8859-16 code page (28606). If SetTargetCodePage
|
|
is <b>False</b>, SetCodePage is called again to apply the CP_ACP (ANSI) code
|
|
page in the return value.
|
|
</p>
|
|
<p>
|
|
For other platforms, the UTF8ToSingleByte routine is called using
|
|
UnicodeToISO_8859_16 to perform character conversions needed for the target
|
|
encoding.
|
|
</p>
|
|
<p>
|
|
UTF8ToISO_8859_16 is used in the implementation of the
|
|
ConvertEncodingFromUTF8 encoding conversion routine.
|
|
</p>
|
|
</descr>
|
|
<seealso>
|
|
<link id="ConvertEncodingFromUTF8"/>
|
|
<link id="UTF8ToSingleByte"/>
|
|
<link id="#rtl.system.SetCodePage">SetCodePage</link>
|
|
</seealso>
|
|
</element>
|
|
<element name="UTF8ToISO_8859_16.Result">
|
|
<short>String value after conversion to ISO 8859-16.</short>
|
|
</element>
|
|
<element name="UTF8ToISO_8859_16.s">
|
|
<short>UTF-8-encoded string value converted in the routine.</short>
|
|
</element>
|
|
<element name="UTF8ToISO_8859_16.SetTargetCodePage">
|
|
<short>
|
|
<b>True</b> if the target code page is set in the return value, <b>False</b>
|
|
if the default system code page (CP_ACP) is used.
|
|
</short>
|
|
</element>
|
|
|
|
<element name="UTF8ToISO_8859_2">
|
|
<short>Converts a string from UTF-8 encoding to ISO 8859-2.</short>
|
|
<descr>
|
|
<p>
|
|
<var>UTF8ToISO_8859_2</var> is a <var>RawByteString</var> function used to
|
|
convert a UTF-8-encoded string to the ISO 8859-2 (Eastern European) encoding.
|
|
</p>
|
|
<p>
|
|
For platforms where system code pages are enabled, SetCodePage is called to
|
|
convert the value to the ISO 8859-2 code page (28592). If SetTargetCodePage
|
|
is <b>False</b>, SetCodePage is called again to apply the CP_ACP (ANSI) code
|
|
page in the return value.
|
|
</p>
|
|
<p>
|
|
For other platforms, the UTF8ToSingleByte routine is called using
|
|
UnicodeToISO_8859_2 to perform character conversions needed for the target
|
|
encoding.
|
|
</p>
|
|
<p>
|
|
UTF8ToISO_8859_2 is used in the implementation of the ConvertEncodingFromUTF8
|
|
encoding conversion routine.
|
|
</p>
|
|
</descr>
|
|
<seealso>
|
|
<link id="ConvertEncodingFromUTF8"/>
|
|
<link id="UTF8ToSingleByte"/>
|
|
<link id="#rtl.system.SetCodePage">SetCodePage</link>
|
|
</seealso>
|
|
</element>
|
|
<element name="UTF8ToISO_8859_2.Result">
|
|
<short>String value after conversion to ISO 8859-2.</short>
|
|
</element>
|
|
<element name="UTF8ToISO_8859_2.s">
|
|
<short>UTF-8-encoded string value converted in the routine.</short>
|
|
</element>
|
|
<element name="UTF8ToISO_8859_2.SetTargetCodePage">
|
|
<short>
|
|
<b>True</b> if the target code page is set in the return value, <b>False</b>
|
|
if the default system code page (CP_ACP) is used.
|
|
</short>
|
|
</element>
|
|
|
|
<element name="UTF8ToISO_8859_3">
|
|
<short>Converts a string from UTF-8 encoding to ISO 8859-3.</short>
|
|
<descr>
|
|
<p>
|
|
<var>UTF8ToISO_8859_3</var> is a <var>RawByteString</var> function used to
|
|
convert a UTF-8-encoded string to the ISO 8859-3 (Latin-3) encoding.
|
|
</p>
|
|
<p>
|
|
For platforms where system code pages are enabled, SetCodePage is called to
|
|
convert the value to the ISO 8859-3 code page (28593). If SetTargetCodePage
|
|
is <b>False</b>, SetCodePage is called again to apply the CP_ACP (ANSI) code
|
|
page in the return value.
|
|
</p>
|
|
<p>
|
|
For other platforms, the UTF8ToSingleByte routine is called using
|
|
UnicodeToISO_8859_3 to perform character conversions needed for the target
|
|
encoding.
|
|
</p>
|
|
<p>
|
|
UTF8ToISO_8859_3 is used in the implementation of the ConvertEncodingFromUTF8
|
|
encoding conversion routine.
|
|
</p>
|
|
</descr>
|
|
<seealso>
|
|
<link id="ConvertEncodingFromUTF8"/>
|
|
<link id="UTF8ToSingleByte"/>
|
|
<link id="#rtl.system.SetCodePage">SetCodePage</link>
|
|
</seealso>
|
|
</element>
|
|
<element name="UTF8ToISO_8859_3.Result">
|
|
<short>String value after conversion to ISO 8859-3.</short>
|
|
</element>
|
|
<element name="UTF8ToISO_8859_3.s">
|
|
<short>UTF-8-encoded string value converted in the routine.</short>
|
|
</element>
|
|
<element name="UTF8ToISO_8859_3.SetTargetCodePage">
|
|
<short>
|
|
<b>True</b> if the target code page is set in the return value, <b>False</b>
|
|
if the default system code page (CP_ACP) is used.
|
|
</short>
|
|
</element>
|
|
|
|
<element name="UTF8ToISO_8859_4">
|
|
<short>Converts a string from UTF-8 encoding to ISO 8859-3.</short>
|
|
<descr>
|
|
<p>
|
|
<var>UTF8ToISO_8859_4</var> is a <var>RawByteString</var> function used to
|
|
convert a UTF-8-encoded string to the ISO 8859-4 (Latin-4) encoding.
|
|
</p>
|
|
<p>
|
|
For platforms where system code pages are enabled, SetCodePage is called to
|
|
convert the value to the ISO 8859-4 code page (28594). If SetTargetCodePage
|
|
is <b>False</b>, SetCodePage is called again to apply the CP_ACP (ANSI) code
|
|
page in the return value.
|
|
</p>
|
|
<p>
|
|
For other platforms, the UTF8ToSingleByte routine is called using
|
|
UnicodeToISO_8859_4 to perform character conversions needed for the target
|
|
encoding.
|
|
</p>
|
|
<p>
|
|
UTF8ToISO_8859_4 is used in the implementation of the ConvertEncodingFromUTF8
|
|
encoding conversion routine.
|
|
</p>
|
|
</descr>
|
|
<seealso>
|
|
<link id="ConvertEncodingFromUTF8"/>
|
|
<link id="UTF8ToSingleByte"/>
|
|
<link id="#rtl.system.SetCodePage">SetCodePage</link>
|
|
</seealso>
|
|
</element>
|
|
<element name="UTF8ToISO_8859_4.Result">
|
|
<short>String value after conversion to ISO 8859-4.</short>
|
|
</element>
|
|
<element name="UTF8ToISO_8859_4.s">
|
|
<short>UTF-8-encoded string value converted in the routine.</short>
|
|
</element>
|
|
<element name="UTF8ToISO_8859_4.SetTargetCodePage">
|
|
<short>
|
|
<b>True</b> if the target code page is set in the return value, <b>False</b>
|
|
if the default system code page (CP_ACP) is used.
|
|
</short>
|
|
</element>
|
|
|
|
<element name="UTF8ToISO_8859_5">
|
|
<short>Converts a string from UTF-8 encoding to ISO 8859-5.</short>
|
|
<descr>
|
|
<p>
|
|
<var>UTF8ToISO_8859_5</var> is a <var>RawByteString</var> function used to
|
|
convert a UTF-8-encoded string to the ISO 8859-5 (Latin/Cyrllic) encoding.
|
|
</p>
|
|
<p>
|
|
For platforms where system code pages are enabled, SetCodePage is called to
|
|
convert the value to the ISO 8859-5 code page (28595). If SetTargetCodePage
|
|
is <b>False</b>, SetCodePage is called again to apply the CP_ACP (ANSI) code
|
|
page in the return value.
|
|
</p>
|
|
<p>
|
|
For other platforms, the UTF8ToSingleByte routine is called using
|
|
UnicodeToISO_8859_5 to perform character conversions needed for the target
|
|
encoding.
|
|
</p>
|
|
<p>
|
|
UTF8ToISO_8859_5 is used in the implementation of the ConvertEncodingFromUTF8
|
|
encoding conversion routine.
|
|
</p>
|
|
</descr>
|
|
<seealso>
|
|
<link id="ConvertEncodingFromUTF8"/>
|
|
<link id="UTF8ToSingleByte"/>
|
|
<link id="#rtl.system.SetCodePage">SetCodePage</link>
|
|
</seealso>
|
|
</element>
|
|
<element name="UTF8ToISO_8859_5.Result">
|
|
<short>String value after conversion to ISO 8859-5.</short>
|
|
</element>
|
|
<element name="UTF8ToISO_8859_5.s">
|
|
<short>UTF-8-encoded string value converted in the routine.</short>
|
|
</element>
|
|
<element name="UTF8ToISO_8859_5.SetTargetCodePage">
|
|
<short>
|
|
<b>True</b> if the target code page is set in the return value, <b>False</b>
|
|
if the default system code page (CP_ACP) is used.
|
|
</short>
|
|
</element>
|
|
|
|
<element name="UTF8ToISO_8859_7">
|
|
<short>Converts a string from UTF-8 encoding to ISO 8859-7.</short>
|
|
<descr>
|
|
<p>
|
|
<var>UTF8ToISO_8859_7</var> is a <var>RawByteString</var> function used to
|
|
convert a UTF-8-encoded string to the ISO 8859-7 (Latin/Greek) encoding.
|
|
</p>
|
|
<p>
|
|
For platforms where system code pages are enabled, SetCodePage is called to
|
|
convert the value to the ISO 8859-7 code page (28597). If SetTargetCodePage
|
|
is <b>False</b>, SetCodePage is called again to apply the CP_ACP (ANSI) code
|
|
page in the return value.
|
|
</p>
|
|
<p>
|
|
For other platforms, the UTF8ToSingleByte routine is called using
|
|
UnicodeToISO_8859_7 to perform character conversions needed for the target
|
|
encoding.
|
|
</p>
|
|
<p>
|
|
UTF8ToISO_8859_7 is used in the implementation of the ConvertEncodingFromUTF8
|
|
encoding conversion routine.
|
|
</p>
|
|
</descr>
|
|
<seealso>
|
|
<link id="ConvertEncodingFromUTF8"/>
|
|
<link id="UTF8ToSingleByte"/>
|
|
<link id="#rtl.system.SetCodePage">SetCodePage</link>
|
|
</seealso>
|
|
</element>
|
|
<element name="UTF8ToISO_8859_7.Result">
|
|
<short>String value after conversion to ISO 8859-7.</short>
|
|
</element>
|
|
<element name="UTF8ToISO_8859_7.s">
|
|
<short>UTF-8-encoded string value converted in the routine.</short>
|
|
</element>
|
|
<element name="UTF8ToISO_8859_7.SetTargetCodePage">
|
|
<short>
|
|
<b>True</b> if the target code page is set in the return value, <b>False</b>
|
|
if the default system code page (CP_ACP) is used.
|
|
</short>
|
|
</element>
|
|
|
|
<element name="UTF8ToISO_8859_9">
|
|
<short>
|
|
Converts a string from UTF-8 encoding to ISO 8859-9 (Turkish) encoding.
|
|
</short>
|
|
<descr>
|
|
<p>
|
|
<var>UTF8ToISO_8859_9</var> is a <var>RawByteString</var> function used to
|
|
convert a UTF-8-encoded string to the ISO 8859-9 (Turkish) encoding.
|
|
</p>
|
|
<p>
|
|
For platforms where system code pages are enabled, SetCodePage is called to
|
|
convert the value to the ISO 8859-9 code page (28599). If SetTargetCodePage
|
|
is <b>False</b>, SetCodePage is called again to apply the CP_ACP (ANSI) code
|
|
page in the return value.
|
|
</p>
|
|
<p>
|
|
For other platforms, the UTF8ToSingleByte routine is called using
|
|
UnicodeToISO_8859_9 to perform character conversions needed for the target
|
|
encoding.
|
|
</p>
|
|
<p>
|
|
UTF8ToISO_8859_9 is used in the implementation of the ConvertEncodingFromUTF8
|
|
encoding conversion routine.
|
|
</p>
|
|
</descr>
|
|
<seealso>
|
|
<link id="ConvertEncodingFromUTF8"/>
|
|
<link id="UTF8ToSingleByte"/>
|
|
<link id="#rtl.system.SetCodePage">SetCodePage</link>
|
|
</seealso>
|
|
</element>
|
|
<element name="UTF8ToISO_8859_9.Result">
|
|
<short>String value after conversion to ISO 8859-9.</short>
|
|
</element>
|
|
<element name="UTF8ToISO_8859_9.s">
|
|
<short>UTF-8-encoded string value converted in the routine.</short>
|
|
</element>
|
|
<element name="UTF8ToISO_8859_9.SetTargetCodePage">
|
|
<short>
|
|
<b>True</b> if the target code page is set in the return value, <b>False</b>
|
|
if the default system code page (CP_ACP) is used.
|
|
</short>
|
|
</element>
|
|
|
|
<element name="UTF8ToISO_8859_10">
|
|
<short>
|
|
Converts a string from UTF-8 encoding to ISO 8859-10 (Latin-6) encoding.
|
|
</short>
|
|
<descr>
|
|
<p>
|
|
<var>UTF8ToISO_8859_10</var> is a <var>RawByteString</var> function used to
|
|
convert a UTF-8-encoded string to the ISO 8859-10 (Latin-6) encoding.
|
|
</p>
|
|
<p>
|
|
For platforms where system code pages are enabled, SetCodePage is called to
|
|
convert the value to the ISO 8859-10 code page (28600). If SetTargetCodePage
|
|
is <b>False</b>, SetCodePage is called again to apply the CP_ACP (ANSI) code
|
|
page in the return value.
|
|
</p>
|
|
<p>
|
|
For other platforms, the UTF8ToSingleByte routine is called using
|
|
UnicodeToISO_8859_10 to perform character conversions needed for the target
|
|
encoding.
|
|
</p>
|
|
<p>
|
|
UTF8ToISO_8859_10 is used in the implementation of the
|
|
ConvertEncodingFromUTF8 encoding conversion routine.
|
|
</p>
|
|
</descr>
|
|
<seealso>
|
|
<link id="ConvertEncodingFromUTF8"/>
|
|
<link id="UTF8ToSingleByte"/>
|
|
<link id="#rtl.system.SetCodePage">SetCodePage</link>
|
|
</seealso>
|
|
</element>
|
|
<element name="UTF8ToISO_8859_10.Result">
|
|
<short>String value after conversion to ISO 8859-10.</short>
|
|
</element>
|
|
<element name="UTF8ToISO_8859_10.s">
|
|
<short>UTF-8-encoded string value converted in the routine.</short>
|
|
</element>
|
|
<element name="UTF8ToISO_8859_10.SetTargetCodePage">
|
|
<short>
|
|
<b>True</b> if the target code page is set in the return value, <b>False</b>
|
|
if the default system code page (CP_ACP) is used.
|
|
</short>
|
|
</element>
|
|
|
|
<element name="UTF8ToISO_8859_13">
|
|
<short>
|
|
Converts a string from UTF-8 encoding to ISO 8859-13 (Latin-7) encoding.
|
|
</short>
|
|
<descr>
|
|
<p>
|
|
<var>UTF8ToISO_8859_13</var> is a <var>RawByteString</var> function used to
|
|
convert a UTF-8-encoded string to the ISO 8859-13 (Latin-7) encoding.
|
|
</p>
|
|
<p>
|
|
For platforms where system code pages are enabled, SetCodePage is called to
|
|
convert the value to the ISO 8859-13 code page (28603). If SetTargetCodePage
|
|
is <b>False</b>, SetCodePage is called again to apply the CP_ACP (ANSI) code
|
|
page in the return value.
|
|
</p>
|
|
<p>
|
|
For other platforms, the UTF8ToSingleByte routine is called using
|
|
UnicodeToISO_8859_13 to perform character conversions needed for the target
|
|
encoding.
|
|
</p>
|
|
<p>
|
|
UTF8ToISO_8859_13 is used in the implementation of the
|
|
ConvertEncodingFromUTF8 encoding conversion routine.
|
|
</p>
|
|
</descr>
|
|
<seealso>
|
|
<link id="ConvertEncodingFromUTF8"/>
|
|
<link id="UTF8ToSingleByte"/>
|
|
<link id="#rtl.system.SetCodePage">SetCodePage</link>
|
|
</seealso>
|
|
</element>
|
|
<element name="UTF8ToISO_8859_13.Result">
|
|
<short>String value after conversion to ISO 8859-13.</short>
|
|
</element>
|
|
<element name="UTF8ToISO_8859_13.s">
|
|
<short>UTF-8-encoded string value converted in the routine.</short>
|
|
</element>
|
|
<element name="UTF8ToISO_8859_13.SetTargetCodePage">
|
|
<short>
|
|
<b>True</b> if the target code page is set in the return value, <b>False</b>
|
|
if the default system code page (CP_ACP) is used.
|
|
</short>
|
|
</element>
|
|
|
|
<element name="UTF8ToCP1250">
|
|
<short>Converts a string from UTF-8 encoding to Code Page 1250.</short>
|
|
<descr>
|
|
<p>
|
|
<var>UTF8ToCP1250</var> is a <var>RawByteString</var> function used to
|
|
convert a UTF-8-encoded string to the Code Page 1250 (Central European)
|
|
encoding.
|
|
</p>
|
|
<p>
|
|
UTF8ToCP1250 calls the UTF8ToSingleByte routine using UnicodeToCP1250 to
|
|
perform character conversions needed for the target encoding. System code
|
|
pages are not used (when enabled) because of a failure when translating
|
|
Unicode code points (#129) to the target code page. The character translation
|
|
table in UnicodeToCP1250 is used instead. When SetTargetCodePage is
|
|
<b>True</b>, SetCodePage is called (without character conversion) to set the
|
|
code page to 1250 in the return value.
|
|
</p>
|
|
<p>
|
|
UTF8ToCP1250 is used in the implementation of the ConvertEncodingFromUTF8
|
|
encoding conversion routine.
|
|
</p>
|
|
</descr>
|
|
<seealso>
|
|
<link id="ConvertEncodingFromUTF8"/>
|
|
<link id="UTF8ToSingleByte"/>
|
|
<link id="#rtl.system.SetCodePage">SetCodePage</link>
|
|
</seealso>
|
|
</element>
|
|
<element name="UTF8ToCP1250.Result">
|
|
<short>String value after conversion to Code Page 1250.</short>
|
|
</element>
|
|
<element name="UTF8ToCP1250.s">
|
|
<short>UTF-8-encoded string value converted in the routine.</short>
|
|
</element>
|
|
<element name="UTF8ToCP1250.SetTargetCodePage">
|
|
<short>
|
|
<b>True</b> if the target code page is set in the return value, <b>False</b>
|
|
if a code page is not used.
|
|
</short>
|
|
</element>
|
|
|
|
<element name="UTF8ToCP1251">
|
|
<short>Converts a string from UTF-8 encoding to Code Page 1251.</short>
|
|
<descr>
|
|
<p>
|
|
<var>UTF8ToCP1251</var> is a <var>RawByteString</var> function used to
|
|
convert a UTF-8-encoded string to the Code Page 1251 (Cyrillic) encoding.
|
|
</p>
|
|
<p>
|
|
UTF8ToCP1251 calls the UTF8ToSingleByte routine using UnicodeToCP1251 to
|
|
perform character conversions needed for the target encoding. System code
|
|
pages are not used (when enabled) because of a failure when translating
|
|
Unicode code points (#152) to the target code page. The character translation
|
|
table in UnicodeToCP1251 is used instead. When SetTargetCodePage is
|
|
<b>True</b>, SetCodePage is called (without character conversion) to set the
|
|
code page to 1251 in the return value.
|
|
</p>
|
|
<p>
|
|
UTF8ToCP1251 is used in the implementation of the ConvertEncodingFromUTF8
|
|
encoding conversion routine.
|
|
</p>
|
|
</descr>
|
|
<seealso>
|
|
<link id="ConvertEncodingFromUTF8"/>
|
|
<link id="UTF8ToSingleByte"/>
|
|
<link id="#rtl.system.SetCodePage">SetCodePage</link>
|
|
</seealso>
|
|
</element>
|
|
<element name="UTF8ToCP1251.Result">
|
|
<short>String value after conversion to Code Page 1251.</short>
|
|
</element>
|
|
<element name="UTF8ToCP1251.s">
|
|
<short>UTF-8-encoded string value converted in the routine.</short>
|
|
</element>
|
|
<element name="UTF8ToCP1251.SetTargetCodePage">
|
|
<short>
|
|
<b>True</b> if the target code page is set in the return value, <b>False</b>
|
|
if a code page is not used.
|
|
</short>
|
|
</element>
|
|
|
|
<element name="UTF8ToCP1252">
|
|
<short>Converts a string from UTF-8 encoding to Code Page 1252.</short>
|
|
<descr>
|
|
<p>
|
|
<var>UTF8ToCP1252</var> is a <var>RawByteString</var> function used to
|
|
convert a UTF-8-encoded string to the Code Page 1252 (Latin 1) encoding.
|
|
</p>
|
|
<p>
|
|
UTF8ToCP1252 calls the UTF8ToSingleByte routine using UnicodeToCP1252 to
|
|
perform character conversions needed for the target encoding. System code
|
|
pages are not used (when enabled) because of a failure when translating
|
|
Unicode code points (#128) to the target code page. The character translation
|
|
table in UnicodeToCP1252 is used instead. When SetTargetCodePage is
|
|
<b>True</b>, SetCodePage is called (without character conversion) to set the
|
|
code page to 1252 in the return value.
|
|
</p>
|
|
<p>
|
|
UTF8ToCP1252 is used in the implementation of the ConvertEncodingFromUTF8
|
|
encoding conversion routine.
|
|
</p>
|
|
</descr>
|
|
<seealso>
|
|
<link id="ConvertEncodingFromUTF8"/>
|
|
<link id="UTF8ToSingleByte"/>
|
|
<link id="#rtl.system.SetCodePage">SetCodePage</link>
|
|
</seealso>
|
|
</element>
|
|
<element name="UTF8ToCP1252.Result">
|
|
<short>String value after conversion to Code Page 1252.</short>
|
|
</element>
|
|
<element name="UTF8ToCP1252.s">
|
|
<short>UTF-8-encoded string value converted in the routine.</short>
|
|
</element>
|
|
<element name="UTF8ToCP1252.SetTargetCodePage">
|
|
<short>
|
|
<b>True</b> if the target code page is set in the return value, <b>False</b>
|
|
if a code page is not used.
|
|
</short>
|
|
</element>
|
|
|
|
<element name="UTF8ToCP1253">
|
|
<short>Converts a string from UTF-8 encoding to Code Page 1253.</short>
|
|
<descr>
|
|
<p>
|
|
<var>UTF8ToCP1253</var> is a <var>RawByteString</var> function used to
|
|
convert a UTF-8-encoded string to the Code Page 1253 (Greek) encoding.
|
|
</p>
|
|
<p>
|
|
UTF8ToCP1253 calls the UTF8ToSingleByte routine using UnicodeToCP1253 to
|
|
perform character conversions needed for the target encoding. System code
|
|
pages are not used (when enabled) because of a failure when translating
|
|
Unicode code points (#129) to the target code page. The character translation
|
|
table in UnicodeToCP1253 is used instead. When SetTargetCodePage is
|
|
<b>True</b>, SetCodePage is called (without character conversion) to set the
|
|
code page to 1253 in the return value.
|
|
</p>
|
|
<p>
|
|
UTF8ToCP1253 is used in the implementation of the ConvertEncodingFromUTF8
|
|
encoding conversion routine.
|
|
</p>
|
|
</descr>
|
|
<seealso>
|
|
<link id="ConvertEncodingFromUTF8"/>
|
|
<link id="UTF8ToSingleByte"/>
|
|
<link id="#rtl.system.SetCodePage">SetCodePage</link>
|
|
</seealso>
|
|
</element>
|
|
<element name="UTF8ToCP1253.Result">
|
|
<short>String value after conversion to Code Page 1253.</short>
|
|
</element>
|
|
<element name="UTF8ToCP1253.s">
|
|
<short>UTF-8-encoded string value converted in the routine.</short>
|
|
</element>
|
|
<element name="UTF8ToCP1253.SetTargetCodePage">
|
|
<short>
|
|
<b>True</b> if the target code page is set in the return value, <b>False</b>
|
|
if a code page is not used.
|
|
</short>
|
|
</element>
|
|
|
|
<element name="UTF8ToCP1254">
|
|
<short>Converts a string from UTF-8 encoding to Code Page 1254.</short>
|
|
<descr>
|
|
<p>
|
|
<var>UTF8ToCP1254</var> is a <var>RawByteString</var> function used to
|
|
convert a UTF-8-encoded string to the Code Page 1254 (Turkish) encoding.
|
|
</p>
|
|
<p>
|
|
UTF8ToCP1254 calls the UTF8ToSingleByte routine using UnicodeToCP1254 to
|
|
perform character conversions needed for the target encoding. System code
|
|
pages are not used (when enabled) because of a failure when translating
|
|
Unicode code points (#129) to the target code page. The character translation
|
|
table in UnicodeToCP1254 is used instead. When SetTargetCodePage is
|
|
<b>True</b>, SetCodePage is called (without character conversion) to set the
|
|
code page to 1254 in the return value.
|
|
</p>
|
|
<p>
|
|
UTF8ToCP1254 is used in the implementation of the ConvertEncodingFromUTF8
|
|
encoding conversion routine.
|
|
</p>
|
|
</descr>
|
|
<seealso>
|
|
<link id="ConvertEncodingFromUTF8"/>
|
|
<link id="UTF8ToSingleByte"/>
|
|
<link id="#rtl.system.SetCodePage">SetCodePage</link>
|
|
</seealso>
|
|
</element>
|
|
<element name="UTF8ToCP1254.Result">
|
|
<short>String value after conversion to Code Page 1254.</short>
|
|
</element>
|
|
<element name="UTF8ToCP1254.s">
|
|
<short>UTF-8-encoded string value converted in the routine.</short>
|
|
</element>
|
|
<element name="UTF8ToCP1254.SetTargetCodePage">
|
|
<short>
|
|
<b>True</b> if the target code page is set in the return value, <b>False</b>
|
|
if a code page is not used.
|
|
</short>
|
|
</element>
|
|
|
|
<element name="UTF8ToCP1255">
|
|
<short>Converts a string from UTF-8 encoding to Code Page 1255.</short>
|
|
<descr>
|
|
<p>
|
|
<var>UTF8ToCP1255</var> is a <var>RawByteString</var> function used to
|
|
convert a UTF-8-encoded string to the Code Page 1255 (Hebrew) encoding.
|
|
</p>
|
|
<p>
|
|
UTF8ToCP1255 calls the UTF8ToSingleByte routine using UnicodeToCP1255 to
|
|
perform character conversions needed for the target encoding. System code
|
|
pages are not used (when enabled) because of a failure when translating
|
|
Unicode code points (#129) to the target code page. The character translation
|
|
table in UnicodeToCP1255 is used instead. When SetTargetCodePage is
|
|
<b>True</b>, SetCodePage is called (without character conversion) to set the
|
|
code page to 1255 in the return value.
|
|
</p>
|
|
<p>
|
|
UTF8ToCP1255 is used in the implementation of the ConvertEncodingFromUTF8
|
|
encoding conversion routine.
|
|
</p>
|
|
</descr>
|
|
<seealso>
|
|
<link id="ConvertEncodingFromUTF8"/>
|
|
<link id="UTF8ToSingleByte"/>
|
|
<link id="#rtl.system.SetCodePage">SetCodePage</link>
|
|
</seealso>
|
|
</element>
|
|
<element name="UTF8ToCP1255.Result">
|
|
<short>String value after conversion to Code Page 1255.</short>
|
|
</element>
|
|
<element name="UTF8ToCP1255.s">
|
|
<short>UTF-8-encoded string value converted in the routine.</short>
|
|
</element>
|
|
<element name="UTF8ToCP1255.SetTargetCodePage">
|
|
<short>
|
|
<b>True</b> if the target code page is set in the return value, <b>False</b>
|
|
if a code page is not used.
|
|
</short>
|
|
</element>
|
|
|
|
<element name="UTF8ToCP1256">
|
|
<short>Converts a string from UTF-8 encoding to Code Page 1256.</short>
|
|
<descr>
|
|
<p>
|
|
<var>UTF8ToCP1256</var> is a <var>RawByteString</var> function used to
|
|
convert a UTF-8-encoded string to the Code Page 1256 (Arabic) encoding.
|
|
</p>
|
|
<p>
|
|
For platforms where system code pages are enabled, SetCodePage is called to
|
|
convert the value to the Arabic code page (1256). If SetTargetCodePage is
|
|
<b>False</b>, SetCodePage is called again to apply the CP_ACP (ANSI) code
|
|
page in the return value.
|
|
</p>
|
|
<p>
|
|
For other platforms, the UTF8ToSingleByte routine is called using
|
|
UnicodeToCP1256 to perform character conversions needed for the target
|
|
encoding.
|
|
</p>
|
|
<p>
|
|
UTF8ToCP1256 is used in the implementation of the ConvertEncodingFromUTF8
|
|
encoding conversion routine.
|
|
</p>
|
|
</descr>
|
|
<seealso>
|
|
<link id="ConvertEncodingFromUTF8"/>
|
|
<link id="UTF8ToSingleByte"/>
|
|
<link id="#rtl.system.SetCodePage">SetCodePage</link>
|
|
</seealso>
|
|
</element>
|
|
<element name="UTF8ToCP1256.Result">
|
|
<short>String value after conversion to Code Page 1256.</short>
|
|
</element>
|
|
<element name="UTF8ToCP1256.s">
|
|
<short>UTF-8-encoded string value converted in the routine.</short>
|
|
</element>
|
|
<element name="UTF8ToCP1256.SetTargetCodePage">
|
|
<short>
|
|
<b>True</b> if the target code page is set in the return value, <b>False</b>
|
|
if the default system code page (CP_ACP) is used.
|
|
</short>
|
|
</element>
|
|
|
|
<element name="UTF8ToCP1257">
|
|
<short>Converts a string from UTF-8 encoding to Code Page 1257.</short>
|
|
<descr>
|
|
<p>
|
|
<var>UTF8ToCP1257</var> is a <var>RawByteString</var> function used to
|
|
convert a UTF-8-encoded string to the Code Page 1257 (Baltic) encoding.
|
|
</p>
|
|
<p>
|
|
UTF8ToCP1257 calls the UTF8ToSingleByte routine using UnicodeToCP1257 to
|
|
perform character conversions needed for the target encoding. System code
|
|
pages are not used (when enabled) because of a failure when translating
|
|
Unicode code points (#129) to the target code page. The character translation
|
|
table in UnicodeToCP1257 is used instead. When SetTargetCodePage is
|
|
<b>True</b>, SetCodePage is called (without character conversion) to set the
|
|
code page to 1257 in the return value.
|
|
</p>
|
|
<p>
|
|
UTF8ToCP1255 is used in the implementation of the ConvertEncodingFromUTF8
|
|
encoding conversion routine.
|
|
</p>
|
|
</descr>
|
|
<seealso>
|
|
<link id="ConvertEncodingFromUTF8"/>
|
|
<link id="UTF8ToSingleByte"/>
|
|
<link id="#rtl.system.SetCodePage">SetCodePage</link>
|
|
</seealso>
|
|
</element>
|
|
<element name="UTF8ToCP1257.Result">
|
|
<short>String value after conversion to Code Page 1257.</short>
|
|
</element>
|
|
<element name="UTF8ToCP1257.s">
|
|
<short>UTF-8-encoded string value converted in the routine.</short>
|
|
</element>
|
|
<element name="UTF8ToCP1257.SetTargetCodePage">
|
|
<short>
|
|
<b>True</b> if the target code page is set in the return value, <b>False</b>
|
|
if a code page is not used.
|
|
</short>
|
|
</element>
|
|
|
|
<element name="UTF8ToCP1258">
|
|
<short>Converts a string from UTF-8 encoding to Code Page 1258.</short>
|
|
<descr>
|
|
<p>
|
|
<var>UTF8ToCP1258</var> is a <var>RawByteString</var> function used to
|
|
convert a UTF-8-encoded string to the Code Page 1258 (Vietnamese) encoding.
|
|
</p>
|
|
<p>
|
|
UTF8ToCP1258 calls the UTF8ToSingleByte routine using UnicodeToCP1258 to
|
|
perform character conversions needed for the target encoding. System code
|
|
pages are not used (when enabled) because of a failure when translating
|
|
Unicode code points (#129) to the target code page. The character translation
|
|
table in UnicodeToCP1258 is used instead. When SetTargetCodePage is
|
|
<b>True</b>, SetCodePage is called (without character conversion) to set the
|
|
code page to 1258 in the return value.
|
|
</p>
|
|
<p>
|
|
UTF8ToCP1258 is used in the implementation of the ConvertEncodingFromUTF8
|
|
encoding conversion routine.
|
|
</p>
|
|
</descr>
|
|
<seealso>
|
|
<link id="ConvertEncodingFromUTF8"/>
|
|
<link id="UTF8ToSingleByte"/>
|
|
<link id="#rtl.system.SetCodePage">SetCodePage</link>
|
|
</seealso>
|
|
</element>
|
|
<element name="UTF8ToCP1258.Result">
|
|
<short>String value after conversion to Code Page 1258.</short>
|
|
</element>
|
|
<element name="UTF8ToCP1258.s">
|
|
<short>UTF-8-encoded string value converted in the routine.</short>
|
|
</element>
|
|
<element name="UTF8ToCP1258.SetTargetCodePage">
|
|
<short>
|
|
<b>True</b> if the target code page is set in the return value, <b>False</b>
|
|
if a code page is not used.
|
|
</short>
|
|
</element>
|
|
|
|
<element name="UTF8ToCP437">
|
|
<short>Converts a string from UTF-8 encoding to Code Page 437.</short>
|
|
<descr>
|
|
<p>
|
|
<var>UTF8ToCP437</var> is a <var>RawByteString</var> function used to convert
|
|
a UTF-8-encoded string to the Code Page 437 (DOS Latin US) encoding.
|
|
</p>
|
|
<p>
|
|
For platforms where system code pages are enabled, SetCodePage is called to
|
|
convert the value to the DOS Latin US code page (437). If SetTargetCodePage
|
|
is <b>False</b>, SetCodePage is called again to apply the CP_ACP (ANSI) code
|
|
page in the return value.
|
|
</p>
|
|
<p>
|
|
For other platforms, the UTF8ToSingleByte routine is called using
|
|
UnicodeToCP437 to perform character conversions needed for the target
|
|
encoding.
|
|
</p>
|
|
<p>
|
|
UTF8ToCP437 is used in the implementation of the ConvertEncodingFromUTF8
|
|
encoding conversion routine.
|
|
</p>
|
|
</descr>
|
|
<seealso>
|
|
<link id="ConvertEncodingFromUTF8"/>
|
|
<link id="UTF8ToSingleByte"/>
|
|
<link id="#rtl.system.SetCodePage">SetCodePage</link>
|
|
</seealso>
|
|
</element>
|
|
<element name="UTF8ToCP437.Result">
|
|
<short>String value after conversion to Code Page 437.</short>
|
|
</element>
|
|
<element name="UTF8ToCP437.s">
|
|
<short>UTF-8-encoded string value converted in the routine.</short>
|
|
</element>
|
|
<element name="UTF8ToCP437.SetTargetCodePage">
|
|
<short>
|
|
<b>True</b> if the target code page is set in the return value, <b>False</b>
|
|
if a code page is not used.
|
|
</short>
|
|
</element>
|
|
|
|
<element name="UTF8ToCP850">
|
|
<short>Converts a string from UTF-8 encoding to Code Page 850.</short>
|
|
<descr>
|
|
<p>
|
|
<var>UTF8ToCP850</var> is a <var>RawByteString</var> function used to convert
|
|
a UTF-8-encoded string to the Code Page 850 (DOS Western Europe) encoding.
|
|
</p>
|
|
<p>
|
|
For platforms where system code pages are enabled, SetCodePage is called to
|
|
convert the value to the DOS Western Europe code page (850). If
|
|
SetTargetCodePage is <b>False</b>, SetCodePage is called again to apply the
|
|
CP_ACP (ANSI) code page in the return value.
|
|
</p>
|
|
<p>
|
|
For other platforms, the UTF8ToSingleByte routine is called using
|
|
UnicodeToCP850 to perform character conversions needed for the target
|
|
encoding.
|
|
</p>
|
|
<p>
|
|
UTF8ToCP850 is used in the implementation of the ConvertEncodingFromUTF8
|
|
encoding conversion routine.
|
|
</p>
|
|
</descr>
|
|
<seealso>
|
|
<link id="ConvertEncodingFromUTF8"/>
|
|
<link id="UTF8ToSingleByte"/>
|
|
<link id="#rtl.system.SetCodePage">SetCodePage</link>
|
|
</seealso>
|
|
</element>
|
|
<element name="UTF8ToCP850.Result">
|
|
<short>String value after conversion to Code Page 850.</short>
|
|
</element>
|
|
<element name="UTF8ToCP850.s">
|
|
<short>UTF-8-encoded string value converted in the routine.</short>
|
|
</element>
|
|
<element name="UTF8ToCP850.SetTargetCodePage">
|
|
<short>
|
|
<b>True</b> if the target code page is set in the return value, <b>False</b>
|
|
if a code page is not used.
|
|
</short>
|
|
</element>
|
|
|
|
<element name="UTF8ToCP852">
|
|
<short>Converts a string from UTF-8 encoding to Code Page 852.</short>
|
|
<descr>
|
|
<p>
|
|
<var>UTF8ToCP852</var> is a <var>RawByteString</var> function used to convert
|
|
a UTF-8-encoded string to the Code Page 852 (DOS Central Europe) encoding.
|
|
</p>
|
|
<p>
|
|
For platforms where system code pages are enabled, SetCodePage is called to
|
|
convert the value to the DOS Central Europe code page (852). If
|
|
SetTargetCodePage is <b>False</b>, SetCodePage is called again to apply the
|
|
CP_ACP (ANSI) code page in the return value.
|
|
</p>
|
|
<p>
|
|
For other platforms, the UTF8ToSingleByte routine is called using
|
|
UnicodeToCP852 to perform character conversions needed for the target
|
|
encoding.
|
|
</p>
|
|
<p>
|
|
UTF8ToCP852 is used in the implementation of the ConvertEncodingFromUTF8
|
|
encoding conversion routine.
|
|
</p>
|
|
</descr>
|
|
<seealso>
|
|
<link id="ConvertEncodingFromUTF8"/>
|
|
<link id="UTF8ToSingleByte"/>
|
|
<link id="#rtl.system.SetCodePage">SetCodePage</link>
|
|
</seealso>
|
|
</element>
|
|
<element name="UTF8ToCP852.Result">
|
|
<short>String value after conversion to Code Page 852.</short>
|
|
</element>
|
|
<element name="UTF8ToCP852.s">
|
|
<short>UTF-8-encoded string value converted in the routine.</short>
|
|
</element>
|
|
<element name="UTF8ToCP852.SetTargetCodePage">
|
|
<short>
|
|
<b>True</b> if the target code page is set in the return value, <b>False</b>
|
|
if a code page is not used.
|
|
</short>
|
|
</element>
|
|
|
|
<element name="UTF8ToCP865">
|
|
<short>Converts a string from UTF-8 encoding to Code Page 865.</short>
|
|
<descr>
|
|
<p>
|
|
<var>UTF8ToCP865</var> is a <var>RawByteString</var> function used to convert
|
|
a UTF-8-encoded string to the Code Page 865 (DOS Nordic) encoding.
|
|
</p>
|
|
<p>
|
|
For platforms where system code pages are enabled, SetCodePage is called to
|
|
convert the value to the DOS Nordic code page (865). If
|
|
SetTargetCodePage is <b>False</b>, SetCodePage is called again to apply the
|
|
CP_ACP (ANSI) code page in the return value.
|
|
</p>
|
|
<p>
|
|
For other platforms, the UTF8ToSingleByte routine is called using
|
|
UnicodeToCP865 to perform character conversions needed for the target
|
|
encoding.
|
|
</p>
|
|
<p>
|
|
UTF8ToCP865 is used in the implementation of the ConvertEncodingFromUTF8
|
|
encoding conversion routine.
|
|
</p>
|
|
</descr>
|
|
<seealso>
|
|
<link id="ConvertEncodingFromUTF8"/>
|
|
<link id="UTF8ToSingleByte"/>
|
|
<link id="#rtl.system.SetCodePage">SetCodePage</link>
|
|
</seealso>
|
|
</element>
|
|
<element name="UTF8ToCP865.Result">
|
|
<short>String value after conversion to Code Page 865.</short>
|
|
</element>
|
|
<element name="UTF8ToCP865.s">
|
|
<short>UTF-8-encoded string value converted in the routine.</short>
|
|
</element>
|
|
<element name="UTF8ToCP865.SetTargetCodePage">
|
|
<short>
|
|
<b>True</b> if the target code page is set in the return value, <b>False</b>
|
|
if a code page is not used.
|
|
</short>
|
|
</element>
|
|
|
|
<element name="UTF8ToCP866">
|
|
<short>Converts a string from UTF-8 encoding to Code Page 866.</short>
|
|
<descr>
|
|
<p>
|
|
<var>UTF8ToCP866</var> is a <var>RawByteString</var> function used to convert
|
|
a UTF-8-encoded string to the Code Page 866 (DOS Cyrillic Russian) encoding.
|
|
</p>
|
|
<p>
|
|
For platforms where system code pages are enabled, SetCodePage is called to
|
|
convert the value to the DOS Cyrillic Russian code page (866). If
|
|
SetTargetCodePage is <b>False</b>, SetCodePage is called again to apply the
|
|
CP_ACP (ANSI) code page in the return value.
|
|
</p>
|
|
<p>
|
|
For other platforms, the UTF8ToSingleByte routine is called using
|
|
UnicodeToCP866 to perform character conversions needed for the target
|
|
encoding.
|
|
</p>
|
|
<p>
|
|
UTF8ToCP866 is used in the implementation of the ConvertEncodingFromUTF8
|
|
encoding conversion routine.
|
|
</p>
|
|
</descr>
|
|
<seealso>
|
|
<link id="ConvertEncodingFromUTF8"/>
|
|
<link id="UTF8ToSingleByte"/>
|
|
<link id="#rtl.system.SetCodePage">SetCodePage</link>
|
|
</seealso>
|
|
</element>
|
|
<element name="UTF8ToCP866.Result">
|
|
<short>String value after conversion to Code Page 866.</short>
|
|
</element>
|
|
<element name="UTF8ToCP866.s">
|
|
<short>UTF-8-encoded string value converted in the routine.</short>
|
|
</element>
|
|
<element name="UTF8ToCP866.SetTargetCodePage">
|
|
<short>
|
|
<b>True</b> if the target code page is set in the return value, <b>False</b>
|
|
if a code page is not used.
|
|
</short>
|
|
</element>
|
|
|
|
<element name="UTF8ToCP874">
|
|
<short>Converts a string from UTF-8 encoding to Code Page 874.</short>
|
|
<descr>
|
|
<p>
|
|
<var>UTF8ToCP874</var> is a <var>RawByteString</var> function used to convert
|
|
a UTF-8-encoded string to the Code Page 874 (Thai) encoding.
|
|
</p>
|
|
<p>
|
|
UTF8ToCP874 calls the UTF8ToSingleByte routine using UnicodeToCP874 to
|
|
perform character conversions needed for the target encoding. System code
|
|
pages are not used (when enabled) because of a failure when translating
|
|
Unicode code points (#129) to the target code page. The character translation
|
|
table in UnicodeToCP874 is used instead. When SetTargetCodePage is
|
|
<b>True</b>, SetCodePage is called (without character conversion) to set the
|
|
code page to 874 in the return value.
|
|
</p>
|
|
<p>
|
|
UTF8ToCP874 is used in the implementation of the ConvertEncodingFromUTF8
|
|
encoding conversion routine.
|
|
</p>
|
|
</descr>
|
|
<seealso>
|
|
<link id="ConvertEncodingFromUTF8"/>
|
|
<link id="UTF8ToSingleByte"/>
|
|
<link id="#rtl.system.SetCodePage">SetCodePage</link>
|
|
</seealso>
|
|
</element>
|
|
<element name="UTF8ToCP874.Result">
|
|
<short>String value after conversion to Code Page 874.</short>
|
|
</element>
|
|
<element name="UTF8ToCP874.s">
|
|
<short>UTF-8-encoded string value converted in the routine.</short>
|
|
</element>
|
|
<element name="UTF8ToCP874.SetTargetCodePage">
|
|
<short>
|
|
<b>True</b> if the target code page is set in the return value, <b>False</b>
|
|
if a code page is not used.
|
|
</short>
|
|
</element>
|
|
|
|
<element name="UTF8ToKOI8R">
|
|
<short>Converts a string from UTF-8 encoding to KOI8-R encoding.</short>
|
|
<descr>
|
|
<p>
|
|
<var>UTF8ToKOI8R</var> is a <var>RawByteString</var> function used to convert
|
|
a UTF-8-encoded string to the KOI8-R (Russian Cyrillic 8-bit) encoding. KOI8R
|
|
stands for Kod Obmena Informatsiey, 8-bit Russian.
|
|
</p>
|
|
<p>
|
|
For platforms where system code pages are enabled, SetCodePage is called to
|
|
convert the value to the KOI8-R code page (20866). If SetTargetCodePage is
|
|
<b>False</b>, SetCodePage is called again to apply the CP_ACP (ANSI) code
|
|
page in the return value.
|
|
</p>
|
|
<p>
|
|
For other platforms, the UTF8ToSingleByte routine is called using
|
|
UnicodeToKOI8R to perform character conversions needed for the target
|
|
encoding.
|
|
</p>
|
|
<p>
|
|
UTF8ToKOI8R is used in the implementation of the ConvertEncodingFromUTF8
|
|
encoding conversion routine.
|
|
</p>
|
|
</descr>
|
|
<seealso/>
|
|
</element>
|
|
<element name="UTF8ToKOI8R.Result">
|
|
<short>String value after conversion to KOI8-R encoding.</short>
|
|
</element>
|
|
<element name="UTF8ToKOI8R.s">
|
|
<short>UTF-8-encoded string value converted in the routine.</short>
|
|
</element>
|
|
<element name="UTF8ToKOI8R.SetTargetCodePage">
|
|
<short>
|
|
<b>True</b> if the target code page is set in the return value, <b>False</b>
|
|
if a code page is not used.
|
|
</short>
|
|
</element>
|
|
|
|
<element name="UTF8ToKOI8U">
|
|
<short>Converts a string from UTF-8 encoding to KOI8-U encoding.</short>
|
|
<descr>
|
|
<p>
|
|
<var>UTF8ToKOI8U</var> is a <var>RawByteString</var> function used to convert
|
|
a UTF-8-encoded string to the KOI8-U (Russian Ukranian 8-bit) encoding. KOI8R
|
|
stands for Kod Obmena Informatsiey, 8-bit Ukranian.
|
|
</p>
|
|
<p>
|
|
For platforms where system code pages are enabled, SetCodePage is called to
|
|
convert the value to the KOI8-U code page (21866). If SetTargetCodePage is
|
|
<b>False</b>, SetCodePage is called again to apply the CP_ACP (ANSI) code
|
|
page in the return value.
|
|
</p>
|
|
<p>
|
|
For other platforms, the UTF8ToSingleByte routine is called using
|
|
UnicodeToKOI8U to perform character conversions needed for the target
|
|
encoding.
|
|
</p>
|
|
<p>
|
|
UTF8ToKOI8U is used in the implementation of the ConvertEncodingFromUTF8
|
|
encoding conversion routine.
|
|
</p>
|
|
</descr>
|
|
<seealso/>
|
|
</element>
|
|
<element name="UTF8ToKOI8U.Result">
|
|
<short>String value after conversion to KOI8-U encoding.</short>
|
|
</element>
|
|
<element name="UTF8ToKOI8U.s">
|
|
<short>UTF-8-encoded string value converted in the routine.</short>
|
|
</element>
|
|
<element name="UTF8ToKOI8U.SetTargetCodePage">
|
|
<short>
|
|
<b>True</b> if the target code page is set in the return value, <b>False</b>
|
|
if a code page is not used.
|
|
</short>
|
|
</element>
|
|
|
|
<element name="UTF8ToKOI8RU">
|
|
<short>Converts a string from UTF-8 encoding to KOI8-RU encoding.</short>
|
|
<descr>
|
|
<p>
|
|
<var>UTF8ToKOI8RU</var> is a <var>RawByteString</var> function used to
|
|
convert a UTF-8-encoded string to the KOI8RU (Russian, Belarusian, Ukranian
|
|
Cyrillic) encoding.
|
|
</p>
|
|
<p>
|
|
UTF8ToKOI8RU calls the UTF8ToSingleByte routine using UnicodeToKOI8RU to
|
|
perform character conversions needed for the target encoding. System code
|
|
pages are not used (when enabled) because KOI8RU does not have an official
|
|
code page. The character translation table in UnicodeToKOI8RU is used to
|
|
convert character values for the encoding. When SetTargetCodePage is
|
|
<b>True</b>, SetCodePage is called (without character conversion) to set the
|
|
code page to 0 in the return value.
|
|
</p>
|
|
<p>
|
|
UTF8ToKOI8RU is used in the implementation of the ConvertEncodingFromUTF8
|
|
encoding conversion routine.
|
|
</p>
|
|
</descr>
|
|
<seealso/>
|
|
</element>
|
|
<element name="UTF8ToKOI8RU.Result">
|
|
<short>String value after conversion to KOI8-RU encoding.</short>
|
|
</element>
|
|
<element name="UTF8ToKOI8RU.s">
|
|
<short>UTF-8-encoded string value converted in the routine.</short>
|
|
</element>
|
|
<element name="UTF8ToKOI8RU.SetTargetCodePage">
|
|
<short>
|
|
<b>True</b> if the target code page is set in the return value, <b>False</b>
|
|
if a code page is not used.
|
|
</short>
|
|
</element>
|
|
|
|
<element name="UTF8ToMacintosh">
|
|
<short>
|
|
Converts a value from UTF-8 encoding to the Macintosh Code Page.
|
|
</short>
|
|
<descr>
|
|
<p>
|
|
<var>UTF8ToMacintosh</var> is a <var>RawByteString</var> function used to
|
|
convert a UTF-8-encoded string to the Apple Macintosh Roman code page.
|
|
</p>
|
|
<p>
|
|
For platforms where system code pages are enabled, SetCodePage is called to
|
|
convert the value to the Macintosh Roman code page (10000). If
|
|
SetTargetCodePage is <b>False</b>, SetCodePage is called again to apply the
|
|
CP_ACP (ANSI) code page in the return value.
|
|
</p>
|
|
<p>
|
|
For other platforms, the UTF8ToSingleByte routine is called using
|
|
UnicodeToMacintosh to perform character conversions needed for the target
|
|
encoding.
|
|
</p>
|
|
<p>
|
|
UTF8ToMacintosh is used in the implementation of the ConvertEncodingFromUTF8
|
|
encoding conversion routine.
|
|
</p>
|
|
</descr>
|
|
<seealso/>
|
|
</element>
|
|
<element name="UTF8ToMacintosh.Result">
|
|
<short>String value after conversion to Macintosh encoding.</short>
|
|
</element>
|
|
<element name="UTF8ToMacintosh.s">
|
|
<short>UTF-8-encoded string value converted in the routine.</short>
|
|
</element>
|
|
<element name="UTF8ToMacintosh.SetTargetCodePage">
|
|
<short>
|
|
<b>True</b> if the target code page is set in the return value, <b>False</b>
|
|
if a code page is not used.
|
|
</short>
|
|
</element>
|
|
|
|
<element name="UTF8ToSingleByte">
|
|
<short>
|
|
Converts a UTF-8-encoded string value to a single-bye character set using a
|
|
conversion function.
|
|
</short>
|
|
<descr>
|
|
<p>
|
|
UTF8ToSingleByte is used in an internal routine to convert the UTF-8-encoded
|
|
value in s by calling the custom conversion routine in UTF8CharConvFunc. The
|
|
return value is a string with the single-byte representation for the string
|
|
value. UTF8ToSingleByte is called when the UseSystemCPConv compiler flag has
|
|
not been defined for the platform, and system code pages are not available
|
|
for the purpose.
|
|
</p>
|
|
<p>
|
|
No actions are performed in the routine when s is an empty string (''), and
|
|
the return value is set to an empty string.
|
|
</p>
|
|
<p>
|
|
UTF8ToSingleByte iterates over the Unicode codepoints in s, and calls the
|
|
routine in UTF8CharConvFunc for each of the codepoints. If a codepoint is not
|
|
handled by the UTF8CodepointToUnicode routine, the value in
|
|
ConvertEncodingErrorMode is used to determine the action taken for the
|
|
character value. This includes:
|
|
</p>
|
|
<dl>
|
|
<dt>ceemSkip</dt>
|
|
<dd>The character value is ignored.</dd>
|
|
<dt>ceemReplace</dt>
|
|
<dd>Inserts a '?' character for the unknown codepoint.</dd>
|
|
<dt>ceemReturnEmpty</dt>
|
|
<dd>Returns an empty string ('') for the conversion routine.</dd>
|
|
<dt>ceemException</dt>
|
|
<dd>Raises an EConvertError exception with the message 'Cannot convert UTF8
|
|
to single byte'.</dd>
|
|
</dl>
|
|
<p>
|
|
UTF8ToSingleByte is called from an internal conversion routine, and occurs
|
|
when the following routines are executed:
|
|
</p>
|
|
<ul>
|
|
<li>UTF8ToISO_8859_1</li>
|
|
<li>UTF8ToISO_8859_2</li>
|
|
<li>UTF8ToISO_8859_3</li>
|
|
<li>UTF8ToISO_8859_4</li>
|
|
<li>UTF8ToISO_8859_5</li>
|
|
<li>UTF8ToISO_8859_7</li>
|
|
<li>UTF8ToISO_8859_9</li>
|
|
<li>UTF8ToISO_8859_10</li>
|
|
<li>UTF8ToISO_8859_13</li>
|
|
<li>UTF8ToISO_8859_14</li>
|
|
<li>UTF8ToISO_8859_15</li>
|
|
<li>UTF8ToCP1250</li>
|
|
<li>UTF8ToCP1251</li>
|
|
<li>UTF8ToCP1252</li>
|
|
<li>UTF8ToCP1253</li>
|
|
<li>UTF8ToCP1254</li>
|
|
<li>UTF8ToCP1255</li>
|
|
<li>UTF8ToCP1256</li>
|
|
<li>UTF8ToCP1257</li>
|
|
<li>UTF8ToCP1258</li>
|
|
<li>UTF8ToCP437</li>
|
|
<li>UTF8ToCP850</li>
|
|
<li>UTF8ToCP852</li>
|
|
<li>UTF8ToCP866</li>
|
|
<li>UTF8ToCP874</li>
|
|
<li>UTF8ToKOI8R</li>
|
|
<li>UTF8ToKOI8U</li>
|
|
<li>UTF8ToKOI8RU</li>
|
|
<li>UTF8ToMacintosh</li>
|
|
</ul>
|
|
</descr>
|
|
<seealso>
|
|
<link id="ConvertEncodingFromUTF8"/>
|
|
<link id="ConvertEncoding"/>
|
|
</seealso>
|
|
</element>
|
|
<element name="UTF8ToSingleByte.Result">
|
|
<short>
|
|
String value after conversion to an encoding using a single-byte character
|
|
set.
|
|
</short>
|
|
</element>
|
|
<element name="UTF8ToSingleByte.s">
|
|
<short>UTF-8-encoded string value converted in the routine.</short>
|
|
</element>
|
|
<element name="UTF8ToSingleByte.UTF8CharConvFunc">
|
|
<short>
|
|
Routine used translate Unicode code points to the singe-byte character set
|
|
for the encoding.
|
|
</short>
|
|
</element>
|
|
|
|
<element name="UTF8ToUCS2LE">
|
|
<short>
|
|
Converts a UTF-8-encoded value to UCS 2-byte Little Endian encoding.
|
|
</short>
|
|
<descr>
|
|
<p>
|
|
UTF8ToUCS2LE converts the string value in s from its multi-byte variable
|
|
length UTF-8 encoding to the fixed length 16-bit character set used in the
|
|
UCS2 LE (Little Endian) encoding. UTF8ToUCS2LE iterates over each of the
|
|
UTF-8 codepoints in s, and calls NtoLE to convert the Unicode character value
|
|
to the Least Significant byte order used in the encoding. Unicode characters
|
|
with a value $FFFF or greater are ignored in the conversion.
|
|
</p>
|
|
<p>
|
|
No actions are performed in the routine when s contains an empty string (''),
|
|
and the return value is set to an empty string as well.
|
|
</p>
|
|
<p>
|
|
UTF8ToUCS2LE does not include a byte order mark (BOM) in the UCS2-encoded
|
|
output.
|
|
</p>
|
|
</descr>
|
|
<seealso/>
|
|
</element>
|
|
<element name="UTF8ToUCS2LE.Result">
|
|
<short>String value after conversion to UCS2 LE encoding.</short>
|
|
</element>
|
|
<element name="UTF8ToUCS2LE.s">
|
|
<short>UTF-8-encoded string value converted in the routine.</short>
|
|
</element>
|
|
|
|
<element name="UTF8ToUCS2BE">
|
|
<short>
|
|
Converts a UTF-8-encoded value to UCS 2-byte Big Endian encoding.
|
|
</short>
|
|
<descr>
|
|
<p>
|
|
UTF8ToUCS2BE converts the string value in s from its multi-byte variable
|
|
length UTF-8 encoding to the fixed length 16-bit character set used in the
|
|
UCS2 BE (Big Endian) encoding. UTF8ToUCS2BE iterates over each of the UTF-8
|
|
codepoints in s, and calls NtoBE to convert the Unicode character value to
|
|
the Most Significant byte order used in the encoding. Unicode characters with
|
|
a value $FFFF or greater are ignored in the conversion.
|
|
</p>
|
|
<p>
|
|
No actions are performed in the routine when s contains an empty string (''),
|
|
and the return value is set to an empty string as well.
|
|
</p>
|
|
<p>
|
|
UTF8ToUCS2BE does not include a byte order mark (BOM) in the UCS2-encoded
|
|
output.
|
|
</p>
|
|
</descr>
|
|
<seealso/>
|
|
</element>
|
|
<element name="UTF8ToUCS2BE.Result">
|
|
<short>String value after conversion to UCS2 BE encoding.</short>
|
|
</element>
|
|
<element name="UTF8ToUCS2BE.s">
|
|
<short>UTF-8-encoded string value converted in the routine.</short>
|
|
</element>
|
|
|
|
<element name="CP932ToUTF8">
|
|
<short>
|
|
Converts a string value using Code Page 932 to UTF-8.
|
|
</short>
|
|
<descr>
|
|
<p>
|
|
<var>CP932ToUTF8</var> is defined for platforms where Asian code pages are
|
|
enabled. It uses the byte maps defined for the Japanese Shift-JIS Double Byte
|
|
Character Set as defined for the Microsoft Windows Code Page 932.
|
|
</p>
|
|
<p>
|
|
The internal implementation ensures that single-byte half-width Katakana
|
|
characters are handled properly when converted to UTF-8. Specifically, the
|
|
characters with an initial byte in the ranges $A0..$DF and $FD..$FF. $A0, $FD,
|
|
$FE, $FF are not allowed as the initial byte in a Shift-JIS character. Values
|
|
in the range $A1..$DF are treated as single-byte half-width codepoints.
|
|
</p>
|
|
</descr>
|
|
<version>
|
|
Modified in LazUtils 4.0 to handle single-byte half-width Katakana character
|
|
ranges.
|
|
</version>
|
|
<seealso/>
|
|
</element>
|
|
<element name="CP932ToUTF8.Result">
|
|
<short>
|
|
String value after conversion to UTF-8 encoding.
|
|
</short>
|
|
</element>
|
|
<element name="CP932ToUTF8.s">
|
|
<short>
|
|
String value using code page 932.
|
|
</short>
|
|
</element>
|
|
|
|
<element name="CP936ToUTF8">
|
|
<short>Converts a string value using Code Page 936 to UTF-8.</short>
|
|
<descr>
|
|
<p>
|
|
CP936ToUTF8 is defined for platforms where Asian code pages are enabled.
|
|
</p>
|
|
</descr>
|
|
<seealso/>
|
|
</element>
|
|
<element name="CP936ToUTF8.Result">
|
|
<short>String value after conversion to UTF-8 encoding.</short>
|
|
</element>
|
|
<element name="CP936ToUTF8.s">
|
|
<short>String value using code page 936.</short>
|
|
</element>
|
|
|
|
<element name="CP949ToUTF8">
|
|
<short>Converts a string value using Code Page 949 to UTF-8.</short>
|
|
<descr>
|
|
<p>
|
|
CP949ToUTF8 is defined for platforms where Asian code pages are enabled.
|
|
</p>
|
|
</descr>
|
|
<seealso/>
|
|
</element>
|
|
<element name="CP949ToUTF8.Result">
|
|
<short>String value after conversion to UTF-8 encoding.</short>
|
|
</element>
|
|
<element name="CP949ToUTF8.s">
|
|
<short>String value using code page 949.</short>
|
|
</element>
|
|
|
|
<element name="CP950ToUTF8">
|
|
<short>Converts a string value using Code Page 950 to UTF-8.</short>
|
|
<descr>
|
|
<p>
|
|
CP950ToUTF8 is defined for platforms where Asian code pages are enabled.
|
|
</p>
|
|
</descr>
|
|
<seealso/>
|
|
</element>
|
|
<element name="CP950ToUTF8.Result">
|
|
<short>String value after conversion to UTF-8 encoding.</short>
|
|
</element>
|
|
<element name="CP950ToUTF8.s">
|
|
<short>String value using code page 950.</short>
|
|
</element>
|
|
|
|
<element name="UTF8ToCP932">
|
|
<short>Converts a string from UTF-8 encoding to Code Page 932.</short>
|
|
<descr>
|
|
<p>
|
|
UTF8ToCP932 is defined for platforms where Asian code pages are enabled.
|
|
</p>
|
|
</descr>
|
|
<seealso>
|
|
<link id="#rtl.system.SetCodePage">SetCodePage</link>
|
|
</seealso>
|
|
</element>
|
|
<element name="UTF8ToCP932.Result">
|
|
<short>String value after conversion to code page 932.</short>
|
|
</element>
|
|
<element name="UTF8ToCP932.s">
|
|
<short>String value using UTF-8 encoding.</short>
|
|
</element>
|
|
<element name="UTF8ToCP932.SetTargetCodePage">
|
|
<short>
|
|
<b>True</b> to set the code page for the result, <b>False</b> to use the ANSI
|
|
code page.
|
|
</short>
|
|
</element>
|
|
|
|
<element name="UTF8ToCP936">
|
|
<short>Converts a string from UTF-8 encoding to Code Page 936.</short>
|
|
<descr>
|
|
<p>
|
|
UTF8ToCP936 is defined for platforms where Asian code pages are enabled.
|
|
</p>
|
|
</descr>
|
|
<seealso>
|
|
<link id="#rtl.system.SetCodePage">SetCodePage</link>
|
|
</seealso>
|
|
</element>
|
|
<element name="UTF8ToCP936.Result">
|
|
<short>String value after conversion to code page 936.</short>
|
|
</element>
|
|
<element name="UTF8ToCP936.s">
|
|
<short>String value using UTF-8 encoding.</short>
|
|
</element>
|
|
<element name="UTF8ToCP936.SetTargetCodePage">
|
|
<short>
|
|
<b>True</b> to set the code page for the result, <b>False</b> to use the ANSI
|
|
code page.
|
|
</short>
|
|
</element>
|
|
|
|
<element name="UTF8ToCP949">
|
|
<short>Converts a string from UTF-8 encoding to Code Page 949.</short>
|
|
<descr>
|
|
<p>
|
|
UTF8ToCP949 is defined for platforms where Asian code pages are enabled.
|
|
</p>
|
|
</descr>
|
|
<seealso>
|
|
<link id="#rtl.system.SetCodePage">SetCodePage</link>
|
|
</seealso>
|
|
</element>
|
|
<element name="UTF8ToCP949.Result">
|
|
<short>String value after conversion to code page 949.</short>
|
|
</element>
|
|
<element name="UTF8ToCP949.s">
|
|
<short>String value using UTF-8 encoding.</short>
|
|
</element>
|
|
<element name="UTF8ToCP949.SetTargetCodePage">
|
|
<short>
|
|
<b>True</b> to set the code page for the result, <b>False</b> to use the ANSI
|
|
code page.
|
|
</short>
|
|
</element>
|
|
|
|
<element name="UTF8ToCP950">
|
|
<short>Converts a string from UTF-8 encoding to Code Page 950.</short>
|
|
<descr>
|
|
<p>
|
|
UTF8ToCP950 is defined for platforms where Asian code pages are enabled.
|
|
</p>
|
|
</descr>
|
|
<seealso>
|
|
<link id="#rtl.system.SetCodePage">SetCodePage</link>
|
|
</seealso>
|
|
</element>
|
|
<element name="UTF8ToCP950.Result">
|
|
<short>String value after conversion to code page 949.</short>
|
|
</element>
|
|
<element name="UTF8ToCP950.s">
|
|
<short>String value using UTF-8 encoding.</short>
|
|
</element>
|
|
<element name="UTF8ToCP950.SetTargetCodePage">
|
|
<short>
|
|
<b>True</b> to set the code page for the result, <b>False</b> to use the ANSI
|
|
code page.
|
|
</short>
|
|
</element>
|
|
|
|
<element name="UTF8ToDBCS">
|
|
<short>
|
|
Converts a value from UTF-8 encoding to a Double Byte Character Set encoding.
|
|
</short>
|
|
<descr>
|
|
<p>
|
|
Defined for platforms where Asian code pages are enabled. This is a common
|
|
function used in all conversion routines which convert UTF-8 to an Asian code
|
|
page.
|
|
</p>
|
|
</descr>
|
|
<seealso/>
|
|
</element>
|
|
<element name="UTF8ToDBCS.Result">
|
|
<short>
|
|
String value using the double-byte character set generated in the conversion
|
|
function.
|
|
</short>
|
|
</element>
|
|
<element name="UTF8ToDBCS.s">
|
|
<short>String value using UTF-8 encoding.</short>
|
|
</element>
|
|
<element name="UTF8ToDBCS.UTF8CharConvFunc">
|
|
<short>
|
|
Conversion routine used to translate characters to the double-byte encoding
|
|
used in the result.
|
|
</short>
|
|
</element>
|
|
|
|
<element name="GetSupportedEncodings">
|
|
<short>
|
|
Adds supported encoding names for the platform to the specified string list.
|
|
</short>
|
|
<descr>
|
|
<p>
|
|
<var>GetSupportedEncodings</var> is a procedure used to get the names for the
|
|
supported encodings on the platform or operating system.
|
|
GetSupportedEncodings adds each of the encoding names to <var>List</var>; it
|
|
does <b>NOT</b> remove any existing content in the string list.
|
|
</p>
|
|
<p>
|
|
GetSupportedEncodings stores the following values in the List argument:
|
|
</p>
|
|
<ul>
|
|
<li>'UTF-8'</li>
|
|
<li>'UTF-8BOM'</li>
|
|
<li>'Ansi'</li>
|
|
<li>'cp1250' (EncodingCP1250)</li>
|
|
<li>'cp1251' (EncodingCP1251)</li>
|
|
<li>'cp1252' (EncodingCP1252)</li>
|
|
<li>'cp1253' (EncodingCP1253)</li>
|
|
<li>'cp1254' (EncodingCP1254)</li>
|
|
<li>'cp1255' (EncodingCP1255)</li>
|
|
<li>'cp1256' (EncodingCP1256)</li>
|
|
<li>'cp1257' (EncodingCP1257)</li>
|
|
<li>'cp1258' (EncodingCP1258)</li>
|
|
<li>'cp437' (EncodingCP437)</li>
|
|
<li>'cp850' (EncodingCP850)</li>
|
|
<li>'cp852' (EncodingCP852)</li>
|
|
<li>'cp865' (EncodingCP865)</li>
|
|
<li>'cp866' (EncodingCP866)</li>
|
|
<li>'cp874' (EncodingCP874)</li>
|
|
</ul>
|
|
<p>
|
|
For platforms that support Asian code pages, the following encoding names are
|
|
added to the list:
|
|
</p>
|
|
<ul>
|
|
<li>'cp932' (EncodingCP932)</li>
|
|
<li>'cp936' (EncodingCP936)</li>
|
|
<li>'cp950' (EncodingCP950)</li>
|
|
<li>'cp949' (EncodingCP949)</li>
|
|
</ul>
|
|
<p>
|
|
The following encoding names are added to the end of the list:
|
|
</p>
|
|
<ul>
|
|
<li>'ISO-8859-1'</li>
|
|
<li>'ISO-8859-2'</li>
|
|
<li>'ISO-8859-3'</li>
|
|
<li>'ISO-8859-4'</li>
|
|
<li>'ISO-8859-5'</li>
|
|
<li>'ISO-8859-7'</li>
|
|
<li>'ISO-8859-9'</li>
|
|
<li>'ISO-8859-10'</li>
|
|
<li>'ISO-8859-13'</li>
|
|
<li>'ISO-8859-14'</li>
|
|
<li>'ISO-8859-15'</li>
|
|
<li>'ISO-8859-16'</li>
|
|
<li>'KOI8-R'</li>
|
|
<li>'KOI8-U'</li>
|
|
<li>'KOI8-RU'</li>
|
|
<li>'Macintosh'</li>
|
|
<li>'UCS-2LE'</li>
|
|
<li>'UCS-2BE'</li>
|
|
</ul>
|
|
<p>
|
|
GetSupportedEncodings is used to implement the encodings menu for the source
|
|
editor in the Lazarus IDE, and to implement the TIpHtmlParser class from the
|
|
Turbo Power IPro package.
|
|
</p>
|
|
</descr>
|
|
<seealso/>
|
|
</element>
|
|
<element name="GetSupportedEncodings.List">
|
|
<short>String list updated with the supported encoding names.</short>
|
|
</element>
|
|
|
|
</module>
|
|
<!-- LConvEncoding -->
|
|
</package>
|
|
</fpdoc-descriptions>
|