miva_array_search()

    
Also See:   miva_array_binarysearch miva_array_clear miva_array_collapse miva_array_copy miva_array_copy_ref miva_array_delete miva_array_deserialize miva_array_elements miva_array_filter miva_array_filter_ref miva_array_find miva_array_insert miva_array_insert_ref miva_array_insert_var miva_array_max miva_array_merge miva_array_merge_ref miva_array_min miva_array_next miva_array_pop miva_array_pop_ref miva_array_previous miva_array_serialize miva_array_shift miva_array_shift_ref miva_array_sort miva_element_exists miva_member_exists miva_struct_members miva_struct_member_callback miva_struct_merge miva_struct_merge_ref

Report a language bug  |  Report a documentation error
Performs an sequential search in "array", starting at "offset". Comparison is made by evaluating "filter_expr" for each element. This allows you to specify the comparison type.
Syntax 
miva_array_search( array var, offset, element var, filter_expr )
Returns the index of the first element in "array" for which filter_expr evaluated as true, or 0 if no elements met this condition.
  • array var = the array that will be searched
  • offset = the starting index for the search
  • element var = a variable name used to reference individual array records. See Example 1
  • filter_expr = an expression similar to the EXPR attribute to MvFILTER. See Example 2

element provides the variable name for the individual elements in the array when evaluating the filter expression. It is a "var" parameter which is made a reference to each element in the array before evaluating the expression.

Example 1:

Given l.data as a structured array

l.data[n]:id
l.data[n]:name
l.data[n]:amount

<MvIF EXPR = "{ miva_array_search( l.data, 1, l.element, 'l.element:id EQ 99' ) }">
    <MvEVAL EXPR="{ l.element:id}">, <MvEVAL EXPR="{ l.element:name}">, <MvEVAL EXPR="{ l.element:amount}"><br>
<MvELSE>
    Record not found.
</MvIF>

filter_expr is an expression similar to the EXPR attribute to MvFILTER. The expression is executed in the same state as the caller of miva_array_search(). All local variables within that context are available and function calls are permitted.

Example 2:

<MvASSIGN NAME = "l.array" INDEX = 1 VALUE = "wombat">
<MvASSIGN NAME = "l.array" INDEX = 2 VALUE = "badger">
<MvASSIGN NAME = "l.array" INDEX = 3 VALUE = "beaver">

<MvASSIGN NAME = "l.badger_pos" VALUE = "{ miva_array_search( l.array, 1, l.element, 'toupper( l.element ) EQ \'BADGER\'' ) }">
+ Add a note
User Annotations: miva_array_search