Sign in Join
FPDoc Onlineexperiment

UnicodeToUtf8 function

In unit System

Convert a unicode (UTF16) string to a UTF8 string

Declaration

pascal
function UnicodeToUtf8(Dest: PAnsiChar; Source: PUnicodeChar; 
 MaxBytes: SizeInt): SizeInt

Description

Utf8ToUnicode converts the buffer in Source with a length of SourceBytes or for a maximum length of MaxBytes (or MaxDestbytes) bytes to the buffer pointed to by Dest. If Dest is Nil it will return the number of bytes needed to convert the UTF16 to UTF8. if MaxDestBytes allows for a null terminator, then it is also added to the output.

The function returns the number of copied bytes, or, if Dest is Nil, then it will return the number of bytes needed to perform the conversion.

Errors

On error, -1 is returned.

See also

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