TCharacter.GetUnicodeCategory function

Member of TCharacterpublicIn unit Character

Get the Unicode category of a character.

Declaration

pascal

class function GetUnicodeCategory(AChar: UnicodeChar): TUnicodeCategory
 ; overload; static
class function GetUnicodeCategory(const AString: UnicodeString; 
 AIndex: Integer): TUnicodeCategory
 ; overload; static
class function GetUnicodeCategory(aChar: UCS4Char): TUnicodeCategory
 ; overload; static

Arguments

`AChar`	UTF16 Character.
`AString`	String containing UTF-16 encoded characters.
`AIndex`	Index of UTF16 encoded character in `AString` to be checked.

Function result

The Unicode character category.

Description

TCharacter.GetUnicodeCategory returns the Unicode category of a character. The character can be presented in 2 ways: AChar, a UTF16 Unicode character, or a surrogate pair in a Unicode string AString starting at position AIndex.

Errors

If AIndex is not a valid character index in the string AString, an EArgumentOutOfRangeException exception is raised. If the character at that position is not complete, an EArgumentException exception is raised.