Skip to content

TCharacter.IsSurrogate

Check whether a Unicode character is a surrogate.

Declaration

Source position: character.pas line 124

public 
class function IsSurrogate(AChar: UnicodeChar) : Boolean;  overload
                          ;  static; overload;

class function IsSurrogate(const AString: UnicodeString; 
                          AIndex: Integer) : Boolean;  overload;  static; overload;

class function IsSurrogate(aChar: UCS4Char) : Boolean;  overload
                          ;  static; overload;

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.

See also

Name Description
EArgumentException Invalid argument passed to a function.
IsControl Check whether a Unicode character is a Unicode control character.
IsDigit Check whether a Unicode character is a digit.
IsHighSurrogate Check whether a Unicode character is a surrogate in the high range.
IsLowSurrogate Check whether a Unicode character is a surrogate in the low range.
IsLetter Check if a Unicode character is a letter.
IsLetterOrDigit Check if a Unicode character is a letter or digit.
IsLower Check if a Unicode character is a lowercase letter.
IsNumber Check if a Unicode character is a number.
IsPunctuation Check if a Unicode character is a punctuation character.
IsSymbol Check if a Unicode character is a symbol character.
IsUpper Check whether a Unicode character is an uppercase letter.
IsWhiteSpace Check whether a Unicode character is a whitespace character.