paweld/lazarus
1
0
Fork 0
mirror of https://gitlab.com/freepascal.org/lazarus/lazarus.git synced 2025-06-22 12:28:15 +02:00
Code Issues Packages Projects Releases Wiki Activity
0544db3052
lazarus/docs/xml/lazutils/lconvencoding.xml

1238 lines
39 KiB
XML
Raw Blame History

<?xml version="1.0" encoding="UTF-8"?>
<fpdoc-descriptions>
<package name="lazutils">
<!--
====================================================================
LConvEncoding
====================================================================
-->
<module name="LConvEncoding">
<short>
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>
</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>
<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>Raise an EConvertError exception with a message releveant to the concersion 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 behaviour of encoding conversion errors for the following:
</p>
<ul>
<li>UTF-8 to single byte encoding</li>
<li>DBCS (Asian) encoding to UTF-8</li>
<li>UTF-8 to DBCS</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>
<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="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 KOI-8R Code Page</short>
</element>
<element name="EncodingCPKOI8U">
<short>Encoding name for KOI-8U Code Page</short>
</element>
<element name="EncodingCPKOI8RU">
<short>Encoding name for KOI-8RU 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="EncodingCPIso15">
<short>Encoding name for ISO 8859-15 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 explict '<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 ASII 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 specified encoding</short>
<descr>
<p>
Used in the implementation of the ConvertEncoding function.
</p>
</descr>
<seealso>
<link id="ConvertEncoding"/>
<link id="ConvertEncodingToUTF8"/>
</seealso>
</element>
<element name="ConvertEncodingFromUTF8.Result">
<short/>
</element>
<element name="ConvertEncodingFromUTF8.s">
<short/>
</element>
<element name="ConvertEncodingFromUTF8.ToEncoding">
<short/>
</element>
<element name="ConvertEncodingFromUTF8.Encoded">
<short/>
</element>
<element name="ConvertEncodingFromUTF8.SetTargetCodePage">
<short/>
</element>
<element name="ConvertEncodingToUTF8">
<short>Converts the specified value to the UTF-8 encoding</short>
<descr>
<p>
Used in the implementation of the ConvertEncoding function.
</p>
</descr>
<seealso>
<link id="ConvertEncoding"/>
<link id="ConvertEncodingFromUTF8"/>
</seealso>
</element>
<element name="ConvertEncodingToUTF8.Result">
<short/>
</element>
<element name="ConvertEncodingToUTF8.s">
<short/>
</element>
<element name="ConvertEncodingToUTF8.FromEncoding">
<short/>
</element>
<element name="ConvertEncodingToUTF8.Encoded">
<short/>
</element>
<element name="ConvertEncoding">
<short>Converts the encoding for a value from its source encoding to the target encoding</short>
<descr/>
<seealso/>
</element>
<element name="ConvertEncoding.Result">
<short/>
</element>
<element name="ConvertEncoding.s">
<short/>
</element>
<element name="ConvertEncoding.FromEncoding">
<short/>
</element>
<element name="ConvertEncoding.ToEncoding">
<short/>
</element>
<element name="ConvertEncoding.SetTargetCodePage">
<short/>
</element>
<element name="GetDefaultTextEncoding">
<short/>
<descr>
<p>
This routine gets the default encoding name used for text from the DefaultTextEncoding unit variable. It contains the encoding use for AnsiString in the RTL.
</p>
</descr>
<seealso/>
</element>
<element name="GetDefaultTextEncoding.Result">
<short>Returns the value in the EncodingAnsi constant ('ansi')</short>
</element>
<element name="GetConsoleTextEncoding">
<short>Gets the encoding used in a console on the platform</short>
<descr>
<p>
This routine returns the console text encoding, which might be different from the normal system encoding on some Windows systems. See
<url href="http://mantis.freepascal.org/view.php?id=20552">
http://mantis.freepascal.org/view.php?id=20552</url>
</p>
</descr>
<seealso/>
</element>
<element name="GetConsoleTextEncoding.Result">
<short/>
</element>
<element name="NormalizeEncoding">
<short>Converts the specified encoding name to lowercase and removes '-' characters</short>
<descr/>
<seealso/>
</element>
<element name="NormalizeEncoding.Result">
<short/>
</element>
<element name="NormalizeEncoding.Encoding">
<short/>
</element>
<element name="TConvertEncodingFunction">
<short>Specifies a function used to convert the encoding for a string value</short>
<descr>
<p>
<var>TConvertEncodingFunction</var> is the type used for the <var>ConvertAnsiToUTF8</var> variable.
</p>
</descr>
<seealso>
<link id="ConvertAnsiToUTF8"/>
</seealso>
</element>
<element name="TConvertEncodingFunction.Result">
<short>Value after converting the value to the required encoding</short>
</element>
<element name="TConvertEncodingFunction.s">
<short>Value examined and converted in the routine</short>
</element>
<element name="TConvertUTF8ToEncodingFunc">
<short/>
<descr/>
<seealso/>
</element>
<element name="TConvertUTF8ToEncodingFunc.Result">
<short/>
</element>
<element name="TConvertUTF8ToEncodingFunc.s">
<short/>
</element>
<element name="TConvertUTF8ToEncodingFunc.SetTargetCodePage">
<short/>
</element>
<element name="TCharToUTF8Table">
<short>Alias for the TCharToUTF8Table type in CodepagesCommon</short>
<descr/>
<seealso/>
</element>
<element name="TUnicodeToCharID">
<short/>
<descr/>
<seealso/>
</element>
<element name="TUnicodeToCharID.Result">
<short/>
</element>
<element name="TUnicodeToCharID.Unicode">
<short/>
</element>
<element name="ConvertAnsiToUTF8">
<short>Routine used to convert from ANSI to UTF-8 encoding</short>
<descr>
<p>
<var>ConvertAnsiToUTF8</var> is a <var>TConvertEncodingFunction</var> variable provides a routine used to convert a String value from its ANSI-encoded value to the UTF-8 encoding.
</p>
</descr>
<seealso>
<link id="TConvertEncodingFunction"/>
</seealso>
</element>
<element name="ConvertUTF8ToAnsi">
<short>Routine used to convert from UTF-8 to ANSI encoding</short>
<descr/>
<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 value to UTF-8</short>
<descr/>
<seealso/>
</element>
<element name="ISO_8859_1ToUTF8.Result">
<short/>
</element>
<element name="ISO_8859_1ToUTF8.s">
<short/>
</element>
<element name="ISO_8859_2ToUTF8">
<short>Converts an ISO 8859-2-encoded value to UTF-8</short>
<descr/>
<seealso/>
</element>
<element name="ISO_8859_2ToUTF8.Result">
<short/>
</element>
<element name="ISO_8859_2ToUTF8.s">
<short/>
</element>
<element name="CP1250ToUTF8">
<short>Converts a Code Page 1250-encoded value to UTF-8</short>
<descr/>
<seealso/>
</element>
<element name="CP1250ToUTF8.Result">
<short/>
</element>
<element name="CP1250ToUTF8.s">
<short/>
</element>
<element name="CP1251ToUTF8">
<short>Converts a Code Page 1251-encoded value to UTF-8</short>
<descr/>
<seealso/>
</element>
<element name="CP1251ToUTF8.Result">
<short/>
</element>
<element name="CP1251ToUTF8.s">
<short/>
</element>
<element name="CP1252ToUTF8">
<short>Converts a Code Page 1252-encoded value to UTF-8</short>
<descr/>
<seealso/>
</element>
<element name="CP1252ToUTF8.Result">
<short/>
</element>
<element name="CP1252ToUTF8.s">
<short/>
</element>
<element name="CP1253ToUTF8">
<short>Converts a Code Page 1253-encoded value to UTF-8</short>
<descr/>
<seealso/>
</element>
<element name="CP1253ToUTF8.Result">
<short/>
</element>
<element name="CP1253ToUTF8.s">
<short/>
</element>
<element name="CP1254ToUTF8">
<short>Converts a Code Page 1254-encoded value to UTF-8</short>
<descr/>
<seealso/>
</element>
<element name="CP1254ToUTF8.Result">
<short/>
</element>
<element name="CP1254ToUTF8.s">
<short/>
</element>
<element name="CP1255ToUTF8">
<short>Converts a Code Page 1255-encoded value to UTF-8</short>
<descr/>
<seealso/>
</element>
<element name="CP1255ToUTF8.Result">
<short/>
</element>
<element name="CP1255ToUTF8.s">
<short/>
</element>
<element name="CP1256ToUTF8">
<short>Converts a Code Page 1256-encoded value to UTF-8</short>
<descr/>
<seealso/>
</element>
<element name="CP1256ToUTF8.Result">
<short/>
</element>
<element name="CP1256ToUTF8.s">
<short/>
</element>
<element name="CP1257ToUTF8">
<short>Converts a Code Page 1257-encoded value to UTF-8</short>
<descr/>
<seealso/>
</element>
<element name="CP1257ToUTF8.Result">
<short/>
</element>
<element name="CP1257ToUTF8.s">
<short/>
</element>
<element name="CP1258ToUTF8">
<short>Converts a Code Page 1258-encoded value to UTF-8</short>
<descr/>
<seealso/>
</element>
<element name="CP1258ToUTF8.Result">
<short/>
</element>
<element name="CP1258ToUTF8.s">
<short/>
</element>
<element name="CP437ToUTF8">
<short>Converts a Code Page 437-encoded value to UTF-8</short>
<descr/>
<seealso/>
</element>
<element name="CP437ToUTF8.Result">
<short/>
</element>
<element name="CP437ToUTF8.s">
<short/>
</element>
<element name="CP850ToUTF8">
<short>Converts a Code Page 850-encoded value to UTF-8</short>
<descr/>
<seealso/>
</element>
<element name="CP850ToUTF8.Result">
<short/>
</element>
<element name="CP850ToUTF8.s">
<short/>
</element>
<element name="CP852ToUTF8">
<short>Converts a Code Page 852-encoded value to UTF-8</short>
<descr/>
<seealso/>
</element>
<element name="CP852ToUTF8.Result">
<short/>
</element>
<element name="CP852ToUTF8.s">
<short/>
</element>
<element name="CP866ToUTF8">
<short>Converts a Code Page 866-encoded value to UTF-8</short>
<descr/>
<seealso/>
</element>
<element name="CP866ToUTF8.Result">
<short/>
</element>
<element name="CP866ToUTF8.s">
<short/>
</element>
<element name="CP874ToUTF8">
<short>Converts a Code Page 874-encoded value to UTF-8</short>
<descr/>
<seealso/>
</element>
<element name="CP874ToUTF8.Result">
<short/>
</element>
<element name="CP874ToUTF8.s">
<short/>
</element>
<element name="KOI8RToUTF8">
<short>Converts a KOI-8R-encoded value to UTF-8</short>
<descr/>
<seealso/>
</element>
<element name="KOI8RToUTF8.Result">
<short/>
</element>
<element name="KOI8RToUTF8.s">
<short/>
</element>
<element name="MacintoshToUTF8">
<short>Converts a value encoded using the the Macintosh Code Page to UTF-8</short>
<descr/>
<seealso/>
</element>
<element name="MacintoshToUTF8.Result">
<short/>
</element>
<element name="MacintoshToUTF8.s">
<short/>
</element>
<element name="SingleByteToUTF8">
<short>Converts a string with single-byte values to UTF-8 using a character mapping table</short>
<descr/>
<seealso>
<link id="TCharToUTF8Table"/>
<link id="#lazutils.codepagescommon.ArrayISO_8859_1ToUTF8">ArrayISO_8859_1ToUTF8</link>
<link id="#lazutils.codepagescommon.ArrayISO_8859_15ToUTF8">ArrayISO_8859_15ToUTF8</link>
<link id="#lazutils.codepagescommon.ArrayISO_8859_2ToUTF8">ArrayISO_8859_2ToUTF8</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 siobngle-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 value in UCS 2-byte LE encoding to UTF8</short>
<descr/>
<seealso/>
</element>
<element name="UCS2LEToUTF8.Result">
<short/>
</element>
<element name="UCS2LEToUTF8.s">
<short/>
</element>
<element name="UCS2BEToUTF8">
<short>Converts a value in UCS 2-byte BE encoding to UTF8</short>
<descr/>
<seealso/>
</element>
<element name="UCS2BEToUTF8.Result">
<short/>
</element>
<element name="UCS2BEToUTF8.s">
<short/>
</element>
<element name="UTF8ToUTF8BOM">
<short>Converts a value in UTF-8 encoding to UTF-8 with a Byte Order Mark</short>
<descr/>
<seealso/>
</element>
<element name="UTF8ToUTF8BOM.Result">
<short/>
</element>
<element name="UTF8ToUTF8BOM.s">
<short/>
</element>
<element name="UTF8ToISO_8859_1">
<short>Converts a value in UTF-8 encoding to ISO 8859-1</short>
<descr/>
<seealso/>
</element>
<element name="UTF8ToISO_8859_1.Result">
<short/>
</element>
<element name="UTF8ToISO_8859_1.s">
<short/>
</element>
<element name="UTF8ToISO_8859_1.SetTargetCodePage">
<short/>
</element>
<element name="UTF8ToISO_8859_2">
<short>Converts a value in UTF-8 encoding to ISO 8859-2</short>
<descr/>
<seealso/>
</element>
<element name="UTF8ToISO_8859_2.Result">
<short/>
</element>
<element name="UTF8ToISO_8859_2.s">
<short/>
</element>
<element name="UTF8ToISO_8859_2.SetTargetCodePage">
<short/>
</element>
<element name="UTF8ToCP1250">
<short>Converts a value in UTF-8 encoding to Code Page 1250</short>
<descr/>
<seealso/>
</element>
<element name="UTF8ToCP1250.Result">
<short/>
</element>
<element name="UTF8ToCP1250.s">
<short/>
</element>
<element name="UTF8ToCP1250.SetTargetCodePage">
<short/>
</element>
<element name="UTF8ToCP1251">
<short>Converts a value in UTF-8 encoding to Code Page 1251</short>
<descr/>
<seealso/>
</element>
<element name="UTF8ToCP1251.Result">
<short/>
</element>
<element name="UTF8ToCP1251.s">
<short/>
</element>
<element name="UTF8ToCP1251.SetTargetCodePage">
<short/>
</element>
<element name="UTF8ToCP1252">
<short>Converts a value in UTF-8 encoding to Code Page 1252</short>
<descr/>
<seealso/>
</element>
<element name="UTF8ToCP1252.Result">
<short/>
</element>
<element name="UTF8ToCP1252.s">
<short/>
</element>
<element name="UTF8ToCP1252.SetTargetCodePage">
<short/>
</element>
<element name="UTF8ToCP1253">
<short>Converts a value in UTF-8 encoding to Code Page 1253</short>
<descr/>
<seealso/>
</element>
<element name="UTF8ToCP1253.Result">
<short/>
</element>
<element name="UTF8ToCP1253.s">
<short/>
</element>
<element name="UTF8ToCP1253.SetTargetCodePage">
<short/>
</element>
<element name="UTF8ToCP1254">
<short>Converts a value in UTF-8 encoding to Code Page 1254</short>
<descr/>
<seealso/>
</element>
<element name="UTF8ToCP1254.Result">
<short/>
</element>
<element name="UTF8ToCP1254.s">
<short/>
</element>
<element name="UTF8ToCP1254.SetTargetCodePage">
<short/>
</element>
<element name="UTF8ToCP1255">
<short>Converts a value in UTF-8 encoding to Code Page 1255</short>
<descr/>
<seealso/>
</element>
<element name="UTF8ToCP1255.Result">
<short/>
</element>
<element name="UTF8ToCP1255.s">
<short/>
</element>
<element name="UTF8ToCP1255.SetTargetCodePage">
<short/>
</element>
<element name="UTF8ToCP1256">
<short>Converts a value in UTF-8 encoding to Code Page 1256</short>
<descr/>
<seealso/>
</element>
<element name="UTF8ToCP1256.Result">
<short/>
</element>
<element name="UTF8ToCP1256.s">
<short/>
</element>
<element name="UTF8ToCP1256.SetTargetCodePage">
<short/>
</element>
<element name="UTF8ToCP1257">
<short>Converts a value in UTF-8 encoding to Code Page 1257</short>
<descr/>
<seealso/>
</element>
<element name="UTF8ToCP1257.Result">
<short/>
</element>
<element name="UTF8ToCP1257.s">
<short/>
</element>
<element name="UTF8ToCP1257.SetTargetCodePage">
<short/>
</element>
<element name="UTF8ToCP1258">
<short>Converts a value in UTF-8 encoding to Code Page 1258</short>
<descr/>
<seealso/>
</element>
<element name="UTF8ToCP1258.Result">
<short/>
</element>
<element name="UTF8ToCP1258.s">
<short/>
</element>
<element name="UTF8ToCP1258.SetTargetCodePage">
<short/>
</element>
<element name="UTF8ToCP437">
<short>Converts a value in UTF-8 encoding to Code Page 437</short>
<descr/>
<seealso/>
</element>
<element name="UTF8ToCP437.Result">
<short/>
</element>
<element name="UTF8ToCP437.s">
<short/>
</element>
<element name="UTF8ToCP437.SetTargetCodePage">
<short/>
</element>
<element name="UTF8ToCP850">
<short>Converts a value in UTF-8 encoding to Code Page 850</short>
<descr/>
<seealso/>
</element>
<element name="UTF8ToCP850.Result">
<short/>
</element>
<element name="UTF8ToCP850.s">
<short/>
</element>
<element name="UTF8ToCP850.SetTargetCodePage">
<short/>
</element>
<element name="UTF8ToCP852">
<short>Converts a value in UTF-8 encoding to Code Page 852</short>
<descr/>
<seealso/>
</element>
<element name="UTF8ToCP852.Result">
<short/>
</element>
<element name="UTF8ToCP852.s">
<short/>
</element>
<element name="UTF8ToCP852.SetTargetCodePage">
<short/>
</element>
<element name="UTF8ToCP866">
<short>Converts a value in UTF-8 encoding to Code Page 866</short>
<descr/>
<seealso/>
</element>
<element name="UTF8ToCP866.Result">
<short/>
</element>
<element name="UTF8ToCP866.s">
<short/>
</element>
<element name="UTF8ToCP866.SetTargetCodePage">
<short/>
</element>
<element name="UTF8ToCP874">
<short>Converts a value in UTF-8 encoding to Code Page 874</short>
<descr/>
<seealso/>
</element>
<element name="UTF8ToCP874.Result">
<short/>
</element>
<element name="UTF8ToCP874.s">
<short/>
</element>
<element name="UTF8ToCP874.SetTargetCodePage">
<short/>
</element>
<element name="UTF8ToKOI8R">
<short>Converts a value in UTF-8 encoding to KOI-8R</short>
<descr/>
<seealso/>
</element>
<element name="UTF8ToKOI8R.Result">
<short/>
</element>
<element name="UTF8ToKOI8R.s">
<short/>
</element>
<element name="UTF8ToKOI8R.SetTargetCodePage">
<short/>
</element>
<element name="UTF8ToKOI8U">
<short>Converts a value in UTF-8 encoding to KOI-8U</short>
<descr/>
<seealso/>
</element>
<element name="UTF8ToKOI8U.Result">
<short/>
</element>
<element name="UTF8ToKOI8U.s">
<short/>
</element>
<element name="UTF8ToKOI8U.SetTargetCodePage">
<short/>
</element>
<element name="UTF8ToKOI8RU">
<short>Converts a value in UTF-8 encoding to KOI-8RU</short>
<descr/>
<seealso/>
</element>
<element name="UTF8ToKOI8RU.Result">
<short/>
</element>
<element name="UTF8ToKOI8RU.s">
<short/>
</element>
<element name="UTF8ToKOI8RU.SetTargetCodePage">
<short/>
</element>
<element name="UTF8ToMacintosh">
<short>Converts a value in UTF-8 encoding to the Macintosh Code Page</short>
<descr/>
<seealso/>
</element>
<element name="UTF8ToMacintosh.Result">
<short/>
</element>
<element name="UTF8ToMacintosh.s">
<short/>
</element>
<element name="UTF8ToMacintosh.SetTargetCodePage">
<short/>
</element>
<element name="UTF8ToSingleByte">
<short>
Converts a UTF-8-encoded value to a single-bye character set using a conversion function
</short>
<descr/>
<seealso/>
</element>
<element name="UTF8ToSingleByte.Result">
<short/>
</element>
<element name="UTF8ToSingleByte.s">
<short/>
</element>
<element name="UTF8ToSingleByte.UTF8CharConvFunc">
<short/>
</element>
<element name="UTF8ToUCS2LE">
<short>Converts a UTF-8-encoded value to UCS 2-byte LE</short>
<descr/>
<seealso/>
</element>
<element name="UTF8ToUCS2LE.Result">
<short/>
</element>
<element name="UTF8ToUCS2LE.s">
<short/>
</element>
<element name="UTF8ToUCS2BE">
<short>Converts a UTF-8-encoded value to UCS 2-byte BE</short>
<descr/>
<seealso/>
</element>
<element name="UTF8ToUCS2BE.Result">
<short/>
</element>
<element name="UTF8ToUCS2BE.s">
<short/>
</element>
<element name="CP932ToUTF8">
<short>Converts a value using Code Page 932 to UTF-8</short>
<descr/>
<seealso/>
</element>
<element name="CP932ToUTF8.Result">
<short/>
</element>
<element name="CP932ToUTF8.s">
<short/>
</element>
<element name="CP936ToUTF8">
<short>Converts a value using Code Page 936 to UTF-8</short>
<descr/>
<seealso/>
</element>
<element name="CP936ToUTF8.Result">
<short/>
</element>
<element name="CP936ToUTF8.s">
<short/>
</element>
<element name="CP949ToUTF8">
<short>Converts a value using Code Page 949 to UTF-8</short>
<descr/>
<seealso/>
</element>
<element name="CP949ToUTF8.Result">
<short/>
</element>
<element name="CP949ToUTF8.s">
<short/>
</element>
<element name="CP950ToUTF8">
<short>Converts a value using Code Page 950 to UTF-8</short>
<descr/>
<seealso/>
</element>
<element name="CP950ToUTF8.Result">
<short/>
</element>
<element name="CP950ToUTF8.s">
<short/>
</element>
<element name="UTF8ToCP932">
<short>Converts a value using UTF-8 encoding to Code Page 932</short>
<descr/>
<seealso/>
</element>
<element name="UTF8ToCP932.Result">
<short/>
</element>
<element name="UTF8ToCP932.s">
<short/>
</element>
<element name="UTF8ToCP932.SetTargetCodePage">
<short/>
</element>
<element name="UTF8ToCP936">
<short>Converts a value using UTF-8 encoding to Code Page 936</short>
<descr/>
<seealso/>
</element>
<element name="UTF8ToCP936.Result">
<short/>
</element>
<element name="UTF8ToCP936.s">
<short/>
</element>
<element name="UTF8ToCP936.SetTargetCodePage">
<short/>
</element>
<element name="UTF8ToCP949">
<short>Converts a value using UTF-8 encoding to Code Page 949</short>
<descr/>
<seealso/>
</element>
<element name="UTF8ToCP949.Result">
<short/>
</element>
<element name="UTF8ToCP949.s">
<short/>
</element>
<element name="UTF8ToCP949.SetTargetCodePage">
<short/>
</element>
<element name="UTF8ToCP950">
<short>Converts a value using UTF-8 encoding to Code Page 950</short>
<descr/>
<seealso/>
</element>
<element name="UTF8ToCP950.Result">
<short/>
</element>
<element name="UTF8ToCP950.s">
<short/>
</element>
<element name="UTF8ToCP950.SetTargetCodePage">
<short/>
</element>
<element name="UTF8ToDBCS">
<short>
Converts a value from UTF-8 encoding to Double Byte Character Set encoding
</short>
<descr/>
<seealso/>
</element>
<element name="UTF8ToDBCS.Result">
<short/>
</element>
<element name="UTF8ToDBCS.s">
<short/>
</element>
<element name="UTF8ToDBCS.UTF8CharConvFunc">
<short/>
</element>
<element name="GetSupportedEncodings">
<short>Fills the specified string list with supported encoding names for the platform</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> removing any existing content in the string list.
</p>
<p>
GetSupportedEncodings stores the following values in List:
</p>
<ul>
<li>'UTF-8'</li>
<li>'UTF-8BOM'</li>
<li>'Ansi'</li>
<li>EncodingCP1250</li>
<li>EncodingCP1251</li>
<li>EncodingCP1252</li>
<li>EncodingCP1253</li>
<li>EncodingCP1254</li>
<li>EncodingCP1255</li>
<li>EncodingCP1256</li>
<li>EncodingCP1257</li>
<li>EncodingCP1258</li>
<li>EncodingCP437</li>
<li>EncodingCP850</li>
<li>EncodingCP852</li>
<li>EncodingCP866</li>
<li>EncodingCP874</li>
</ul>
<p>
For platforms that support Asian code pages, the following encoding names are added to the list:
</p>
<ul>
<li>EncodingCP932</li>
<li>EncodingCP936</li>
<li>EncodingCP950</li>
<li>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-15'</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>
</descr>
<seealso/>
</element>
<element name="GetSupportedEncodings.List">
<short>String list where supported encoding names are added</short>
</element>
</module>
<!-- LConvEncoding -->
</package>
</fpdoc-descriptions>
Reference in New Issue View Git Blame Copy Permalink