tuple_strstrtuple_strstrTupleStrstrTupleStrstr (Operator)


tuple_strstrtuple_strstrTupleStrstrTupleStrstr — Forward search for strings within a string tuple.


tuple_strstr( : : String, ToFind : Position)

Herror tuple_strstr(const char* String, const char* ToFind, Hlong* Position)

Herror T_tuple_strstr(const Htuple String, const Htuple ToFind, Htuple* Position)

void TupleStrstr(const HTuple& String, const HTuple& ToFind, HTuple* Position)

HTuple HTuple::TupleStrstr(const HTuple& ToFind) const

static void HOperatorSet.TupleStrstr(HTuple stringVal, HTuple toFind, out HTuple position)

HTuple HTuple.TupleStrstr(HTuple toFind)


tuple_strstrtuple_strstrTupleStrstrTupleStrstrTupleStrstr searches within the strings of the input tuple StringStringStringStringstringVal for the strings of the input tuple ToFindToFindToFindToFindtoFind. Both input tuples may only consist of strings. Otherwise tuple_strstrtuple_strstrTupleStrstrTupleStrstrTupleStrstr returns an error. If StringStringStringStringstringVal contains only one string, all strings of ToFindToFindToFindToFindtoFind are searched in it. Thus, the output tuple consists of as many elements as ToFindToFindToFindToFindtoFind. Whenever a searched string has been found, the position of its first occurrence gets stored in the output tuple PositionPositionPositionPositionposition (positions in strings are counted starting with 0). If a string can not be found, -1 will be returned instead of its position. If both input tuples show the same number of elements, the strings are searched elementwise. I.e., the first string of ToFindToFindToFindToFindtoFind is searched within the first string of StringStringStringStringstringVal, the second string of ToFindToFindToFindToFindtoFind is searched within the second string of StringStringStringStringstringVal and so on. The results of the elementwise searches are returned with PositionPositionPositionPositionposition that contains as many elements as StringStringStringStringstringVal and ToFindToFindToFindToFindtoFind. If ToFindToFindToFindToFindtoFind only contains one string, this is searched within all strings of StringStringStringStringstringVal. Thus, in this case PositionPositionPositionPositionposition consists of as many elements as StringStringStringStringstringVal. If both input tuples contain more than one element and the number of elements differs for the input tuples, tuple_strstrtuple_strstrTupleStrstrTupleStrstrTupleStrstr returns an error.

If either or both of the input tuples are empty, the operator returns an empty tuple.

Unicode code points versus bytes

The position references Unicode code points. One Unicode code point may be composed of multiple bytes in the UTF-8 string. If the position 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')set_system("tsp_tuple_string_operator_mode", "byte")SetSystem("tsp_tuple_string_operator_mode", "byte")SetSystem("tsp_tuple_string_operator_mode", "byte")SetSystem("tsp_tuple_string_operator_mode", "byte"). If 'filename_encoding'"filename_encoding""filename_encoding""filename_encoding""filename_encoding" is set to 'locale'"locale""locale""locale""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_strstrtuple_strstrTupleStrstrTupleStrstrTupleStrstr, which can be used in an expression in the following syntax:

Position := strstr(String, ToFind)

Execution Information


StringStringStringStringstringVal (input_control)  string(-array) HTupleHTupleHtuple (string) (string) (HString) (char*)

Input tuple with string(s) to examine.

ToFindToFindToFindToFindtoFind (input_control)  string(-array) HTupleHTupleHtuple (string) (string) (HString) (char*)

Input tuple with string(s) to search.

PositionPositionPositionPositionposition (output_control)  integer(-array) HTupleHTupleHtuple (integer) (int / long) (Hlong) (Hlong)

Position of searched string(s) within the examined string(s).


tuple_strrstrtuple_strrstrTupleStrrstrTupleStrrstrTupleStrrstr, tuple_strlentuple_strlenTupleStrlenTupleStrlenTupleStrlen, tuple_strchrtuple_strchrTupleStrchrTupleStrchrTupleStrchr, tuple_strrchrtuple_strrchrTupleStrrchrTupleStrrchrTupleStrrchr, tuple_substrtuple_substrTupleSubstrTupleSubstrTupleSubstr, tuple_str_first_ntuple_str_first_nTupleStrFirstNTupleStrFirstNTupleStrFirstN, tuple_str_last_ntuple_str_last_nTupleStrLastNTupleStrLastNTupleStrLastN, tuple_splittuple_splitTupleSplitTupleSplitTupleSplit, tuple_environmenttuple_environmentTupleEnvironmentTupleEnvironmentTupleEnvironment