ClassesClassesClassesClasses | | | | Operators

tuple_str_first_ntuple_str_first_nTupleStrFirstNtuple_str_first_nTupleStrFirstNTupleStrFirstN (Operator)

Name

tuple_str_first_ntuple_str_first_nTupleStrFirstNtuple_str_first_nTupleStrFirstNTupleStrFirstN — Cut the first characters up to position “n” out of a string tuple.

Signature

tuple_str_first_n( : : String, Position : Substring)

Herror tuple_str_first_n(const char* String, const Hlong Position, char* Substring)

Herror T_tuple_str_first_n(const Htuple String, const Htuple Position, Htuple* Substring)

Herror tuple_str_first_n(const HTuple& String, const HTuple& Position, char* Substring)

Herror tuple_str_first_n(const HTuple& String, const HTuple& Position, HTuple* Substring)

void TupleStrFirstN(const HTuple& String, const HTuple& Position, HTuple* Substring)

HTuple HTuple::TupleStrFirstN(const HTuple& Position) const

void HOperatorSetX.TupleStrFirstN(
[in] VARIANT String, [in] VARIANT Position, [out] VARIANT* Substring)

VARIANT HTupleX.TupleStrFirstN(
[in] VARIANT String, [in] VARIANT Position)

static void HOperatorSet.TupleStrFirstN(HTuple stringVal, HTuple position, out HTuple substring)

HTuple HTuple.TupleStrFirstN(HTuple position)

Description

tuple_str_first_ntuple_str_first_nTupleStrFirstNtuple_str_first_nTupleStrFirstNTupleStrFirstN cuts the first characters up to position “n” out of each string of the input tuple StringStringStringStringStringstringVal and returns them as new strings in the output tuple SubstringSubstringSubstringSubstringSubstringsubstring (remark: the position within strings starts with 0 for the first character of a string). The number “n” is determined by the second input tuple PositionPositionPositionPositionPositionposition. If PositionPositionPositionPositionPositionposition only contains one element, this element contains the number “n”. If StringStringStringStringStringstringVal and PositionPositionPositionPositionPositionposition have got the same number of elements, the first element of PositionPositionPositionPositionPositionposition determines the position “n” for the first string of StringStringStringStringStringstringVal, the second element of PositionPositionPositionPositionPositionposition does so for the second string of StringStringStringStringStringstringVal and so on. If PositionPositionPositionPositionPositionposition contains more than one element and StringStringStringStringStringstringVal contains only one string, tuple_str_first_ntuple_str_first_nTupleStrFirstNtuple_str_first_nTupleStrFirstNTupleStrFirstN cuts more than one substrings out of this string. The elements of PositionPositionPositionPositionPositionposition then determine the lengths of these substrings. If both input tuples contain more than one element but differ in the number of elements, tuple_str_first_ntuple_str_first_nTupleStrFirstNtuple_str_first_nTupleStrFirstNTupleStrFirstN returns an error.

For general information about string operations see Tuple / String Operations.

Exception: Empty input tuples

If both input tuples are empty, the operator returns an empty tuple. Similarly, if StringStringStringStringStringstringVal is empty and PositionPositionPositionPositionPositionposition is not, the operator returns an empty tuple. In contrast, if PositionPositionPositionPositionPositionposition is empty and StringStringStringStringStringstringVal is not, an exception is raised.

HDevelop In-line Operation

HDevelop provides an in-line operation for tuple_str_first_ntuple_str_first_nTupleStrFirstNtuple_str_first_nTupleStrFirstNTupleStrFirstN, which can be used in an expression in the following syntax:

Substring := str_firstn(String, Position)

Parallelization

Parameters

StringStringStringStringStringstringVal (input_control)  string(-array) HTupleHTupleHTupleVARIANTHtuple (string) (string) (HString) (char*) (BSTR) (char*)

Input tuple with string(s) to examine.

PositionPositionPositionPositionPositionposition (input_control)  number(-array) HTupleHTupleHTupleVARIANTHtuple (integer / real) (int / long / double) (Hlong / double) (Hlong / double) (Hlong / double) (Hlong / double)

Input tuple with position(s) “n”.

SubstringSubstringSubstringSubstringSubstringsubstring (output_control)  string(-array) HTupleHTupleHTupleVARIANTHtuple (string) (string) (HString) (char*) (BSTR) (char*)

The first characters of the string(s) up to position “n”.

Alternatives

tuple_str_last_ntuple_str_last_nTupleStrLastNtuple_str_last_nTupleStrLastNTupleStrLastN, tuple_substrtuple_substrTupleSubstrtuple_substrTupleSubstrTupleSubstr, tuple_strstrtuple_strstrTupleStrstrtuple_strstrTupleStrstrTupleStrstr, tuple_strrstrtuple_strrstrTupleStrrstrtuple_strrstrTupleStrrstrTupleStrrstr, tuple_strlentuple_strlenTupleStrlentuple_strlenTupleStrlenTupleStrlen, tuple_strchrtuple_strchrTupleStrchrtuple_strchrTupleStrchrTupleStrchr, tuple_strrchrtuple_strrchrTupleStrrchrtuple_strrchrTupleStrrchrTupleStrrchr, tuple_splittuple_splitTupleSplittuple_splitTupleSplitTupleSplit, tuple_environmenttuple_environmentTupleEnvironmenttuple_environmentTupleEnvironmentTupleEnvironment

Module

Foundation


ClassesClassesClassesClasses | | | | Operators