TCharacter.ToLower function

Member of TCharacterpublicIn unit Character

Convert a character or string to lowercase.

Declaration

pascal

class function ToLower(AChar: UnicodeChar): UnicodeChar; overload
 ; static
class function ToLower(const AString: UnicodeString): UnicodeString
 ; overload; static
class function ToLower(const AString: UnicodeString; 
 const AOptions: TCharacterOptions): UnicodeString
 ; overload; static
class function ToLower(aChar: UCS4Char): UCS4Char; overload; static

Arguments

`AChar`	UTF16 Character.
`AString`	String containing UTF-16 encoded characters.
`AOptions`	Options controlling the behaviour of the conversion.

Function result

The lowercase version of the character or string.

Description

ToLower converts the Unicode character AChar or string AString to lowercase. Options determines the behaviour of the conversion: if AOptions contains coIgnoreInvalidSequence then no exception will be raised when the string or character contains an invalid Unicode sequence. The default behaviour is to raise an EArgumentException exception when this happens.

Errors

If an invalid character is encountered, an EArgumentException exception is raised, unless coIgnoreInvalidSequence is specified in the options.