tuple_substr🔗
Short description🔗
tuple_substr — Cut characters from position “n1” through “n2” out of a string tuple.
Signature🔗
tuple_substr( string String, number Position1, number Position2, out string Substring )
Description🔗
tuple_substr cuts all characters from position “n1” through “n2”
out of each string of the input tuple String and
returns them as new strings in the output tuple Substring. The
positions “n1” and “n2” are determined by the second and third input
tuples Position1 and Position2. Their
length has to be equal. If Position1 and Position2 only
contain one element, this element defines for all strings of
String “n1” and “n2”, respectively . If
String, Position1 and Position2 have got the
same number of elements, the first elements of Position1 and
Position2 determine the start and end position for the
first string of String. The second elements of Position1
and Position2 do so for the second string of String
and so on. If Position1 and Position2
contain more than one element and String contains only one string,
tuple_substr cuts more than one substring out of this string.
The elements of Position1 and Position2 then determine
the start and end positions for
these substrings. If all input tuples contain more than one element but
differ in the number of elements, tuple_substr returns an error.
If String is an empty tuple, the operator returns an empty tuple.
If String is not empty and Position1 and/or
Position2 are empty tuples, an exception is raised.
Unicode code points versus bytes🔗
The positions reference Unicode code points. One Unicode code point may be
composed of multiple bytes in the UTF-8 string. If the positions should
reference the raw bytes of the string, this operator can be switched to byte
mode with set_system('tsp_tuple_string_operator_mode','byte'). If
'filename_encoding' is set to 'locale' (legacy), this
operator always uses the byte mode.
For general information about string operations see Tuple / String Operations.
HDevelop In-line Operation🔗
HDevelop provides an in-line operation for tuple_substr,
which can be used in an expression in the following syntax:
texttt{Substring := String{Position1:Position2}}
Execution information🔗
Execution information
-
Multithreading type: reentrant (runs in parallel with non-exclusive operators).
-
Multithreading scope: global (may be called from any thread).
-
Processed without parallelization.
Parameters🔗
String (input_control) string(-array) → (string)
Input tuple with string(s) to examine.
Position1 (input_control) number(-array) → (integer / real)
Input tuple with start position(s) “n1”.
Position2 (input_control) number(-array) → (integer / real)
Input tuple with end position(s) “n2”.
Substring (output_control) string(-array) → (string)
Characters of the string(s) from position “n1” to “n2”.
Combinations with other operators🔗
Combinations
Alternatives
tuple_str_first_n, tuple_str_last_n, tuple_strstr, tuple_strrstr, tuple_strlen, tuple_strchr, tuple_strrchr, tuple_split, tuple_environment
Module🔗
Foundation