Extensions.Util.ListIndexOf

From emotive
Revision as of 11:25, 25 October 2018 by Hb (talk | contribs)
Jump to navigation Jump to search

Classification

Name ListIndexOf
Short Description Gets the first index of a given value
Class Term
Extension OTX Util extension
Group Util related terms
Exceptions -
Checker Rules -
Standard Compliant Yes

OTL Syntax

/// Local Declarations
Integer IntegerVariable;
/// Flow
IntegerVariable = Util.ListIndexOf(ListTerm, Term);

Description

The OTX ListIndexOf term is an IntegerTerm that returns the first index of a given value in the List. In case the value is not contained inside the list, -1 will be returned.

Return Value

The Term returns the value, see table below.

Icons Note.png In OTX, Terms are categorized according to its return data type!
Data Type Description
Integer The first index of a given value in the List. In case the value is not contained inside the list, -1 will be returned.

Properties

Name Data Type Class Default Cardinality Description
List List Term - [1..1] The List which shall be checked for the value.
Value - Term - [1..1] The value whose index in the List shall be determined.

OTL Examples

/// Local Declarations

Integer Integer1;

/// Flow

Integer1 = Util.ListIndexOf({&AA, &AB, &AC}, &AB);

See also

Compare
CopyByteField
GetRandomNumber
IsInitialized
ListIndexOfAny
ListReverse
ListSort
Max
Min
StringFormat