Sign in Join
FPDoc Onlineexperiment

TCharacter.ToUpper function

Member of TCharacterpublicIn unit Character

Convert a character or string to uppercase.

Declaration

pascal
class function ToUpper(AChar: UnicodeChar): UnicodeChar; overload
 ; static
class function ToUpper(const AString: UnicodeString): UnicodeString
 ; overload; static
class function ToUpper(const AString: UnicodeString; 
 const AOptions: TCharacterOptions): UnicodeString
 ; overload; static
class function ToUpper(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 uppercase version of the character or string.

Description

ToUpper converts the Unicode character AChar or string AString to uppercase. 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.

See also

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