Constants (GVL) ¶ InOut: Scope Name Type Initial Comment Constant c_diRuneError RUNE DINT#16#FFFD The “error” Rune or “Unicode replacement character” c_diMaxRune DINT DINT#16#10FFFF
RUNE (ALIAS) ¶ TYPE RUNE : UTF8.|dRUNE| The term rune appears in the libraries and source code, and means exactly the same as “unicode code point”, with one interesting addition. This library defines the word rune as an alias for the type DINT , so programs can be clear when an integer value represents a code point. Moreover, what you might think of as a character constant is called a rune constant. The type and value of the expression WSTRING#"⌘" is a rune with the integer value DINT#16#2318 .
Functions ¶ DecodeRune (Function) DecodeSurrogate (Function) EncodeRune (Function) EncodeSurrogate (Function) IsSurrogate (Function)
DecodeRune (FUN) ¶ FUNCTION DecodeRune : RUNE Unpacks the first UTF-16 encoding in pbyData and returns the rune and the length of the encoding in bytes. InOut: Scope Name Type Initial Return DecodeRune RUNE Input pbyData POINTER TO BYTE udiSize UDINT xHostByteOrder BOOL TRUE Output udiLength UDINT
DecodeSurrogate (FUN) ¶ FUNCTION DecodeSurrogate : Rune Returns the UTF-16 decoding of a surrogate pair. If the pair is not a valid UTF-16 surrogate pair, DecodeSurrogate returns the Unicode replacement code point U+FFFD ( c_diRuneError ). InOut: Scope Name Type Return DecodeSurrogate Rune Input diRune1 Rune diRune2 Rune
EncodeRune (FUN) ¶ FUNCTION EncodeRune : UDINT Writes into pbyData (which must be large enough) the UTF-16 encoding of diRune . It returns the number of bytes written. InOut: Scope Name Type Initial Return EncodeRune UDINT Input diRune RUNE pbyData POINTER TO BYTE udiSize UDINT xHostByteOrder BOOL TRUE
EncodeSurrogate (FUN) ¶ FUNCTION EncodeSurrogate Returns the UTF-16 surrogate pair diRune1 , diRune2 for the given diRune . If the rune is not a valid Unicode code point or does not need encoding, EncodeRune returns U+FFFD ( c_diRuneError ). InOut: Scope Name Type Input diRune Rune Output diRune1 Rune diRune2 Rune
IsSurrogate (FUN) ¶ FUNCTION IsSurrogate : BOOL reports whether the specified Unicode code point can appear in a surrogate pair. InOut: Scope Name Type Return IsSurrogate BOOL Input diRune RUNE
Charmaps (GVL) ¶ InOut: Name Type Windows_1252 Win1252 UTF8_Encoding UTF_8
Functions ¶ BOM DecodeBOM (Function) EncodeBOM (Function) IsHostByteOrder (Function) Memory COPY_TO_MEMORY (Function) FROM_MEMORY (Function) STRING COPY_TO_STRING (Function) FROM_STRING (Function) WSTRING COPY_TO_WSTRING (Function) FROM_WSTRING (Function)