Unit 'Character' Package
[Overview][Types][Classes][Procedures and functions][Index] [#rtl]

TCharacter.IsSurrogatePair

Check if a pair of characters is a set of high/low surrogate characters.

Declaration

Source position: character.pas line 136

public class function TCharacter.IsSurrogatePair(

  const AHighSurrogate: UnicodeChar;

  const ALowSurrogate: UnicodeChar

):Boolean; overload;

class function TCharacter.IsSurrogatePair(

  const AString: UnicodeString;

  AIndex: Integer

):Boolean; overload;

Arguments

AHighSurrogate

  

High surrogate character in pair.

ALowSurrogate

  

Low surrogate character in pair.

Function result

True if AHighSurrogate and ALowSurrogate form a valid Unicode surrogate pair.

Arguments

AString

  

String containing UTF-16 encoded characters.

AIndex

  

Index of UTF16 encoded character in AString to be checked.

Description

IsSurrogatePair returns True if AHighSurrogate and ALowSurrogate form a valid Unicode surrogate pair. (AHighSurrogate is a high surrogate and ALowSurrogate a matching low surrogate) The character can be specified as a UTF16 character AChar or a pair of UTF16 encoded characters 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

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.

IsSurrogate

  

Check whether a Unicode character is a surrogate.

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.


Documentation generated on: Oct 27 2024