Sign in Join
FPDoc Onlineexperiment

TCharacter.IsPunctuation function

Member of TCharacterpublicIn unit Character

Check if a Unicode character is a punctuation character.

Declaration

pascal
class function IsPunctuation(AChar: UnicodeChar): Boolean; overload
 ; static
class function IsPunctuation(const AString: UnicodeString; 
 AIndex: Integer): Boolean; overload
 ; static
class function IsPunctuation(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 characters is a punctuation character.

Description

IsPunctuation returns True if a Unicode character has category that is one of the punctuation categories ( ucConnectPunctuation, ucDashPunctuation, ucOpenPunctuation, ucClosePunctuation, ucInitialPunctuation, ucFinalPunctuation, ucOtherPunctuation). 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

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