Sign in Join
FPDoc Onlineexperiment

UTF8ToCP1256 function

In unit LConvEncoding

Converts a string from UTF-8 encoding to Code Page 1256.

Declaration

pascal
function UTF8ToCP1256(const s: string; SetTargetCodePage: Boolean=False)
: RawByteString

Arguments

s

UTF-8-encoded string value converted in the routine.

SetTargetCodePageTrue if the target code page is set in the return value, False if the default system code page (CP_ACP) is used.

Function result

String value after conversion to Code Page 1256.

Description

UTF8ToCP1256 is a RawByteString function used to convert a UTF-8-encoded string to the Code Page 1256 (Arabic) encoding.

For platforms where system code pages are enabled, SetCodePage is called to convert the value to the Arabic code page (1256). If SetTargetCodePage is False, SetCodePage is called again to apply the CP_ACP (ANSI) code page in the return value.

For other platforms, the UTF8ToSingleByte routine is called using UnicodeToCP1256 to perform character conversions needed for the target encoding.

UTF8ToCP1256 is used in the implementation of the ConvertEncodingFromUTF8 encoding conversion routine.

See also

An experiment, built from development snapshots. Not the official Free Pascal or Lazarus documentation.