TCharacter.IsSurrogate function

Member of TCharacterpublicIn unit Character

Check whether a Unicode character is a surrogate.

Declaration

pascal

class function IsSurrogate(AChar: UnicodeChar): Boolean; overload
 ; static
class function IsSurrogate(const AString: UnicodeString; 
 AIndex: Integer): Boolean; overload; static
class function IsSurrogate(aChar: UCS4Char): Boolean; 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

True if the indicated character has category ucSurrogate.

Description

IsSurrogate returns True if a Unicode character has category ucSurrogate. The character can be specified as a UTF16 character AChar or a UTF16 encoded character starting at position AIndex in string AString.

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.