Find (MarksStoreArray function): Difference between revisions

From m204wiki
Jump to navigation Jump to search
Line 16: Line 16:


==Usage notes==
==Usage notes==
<ul>
<li>The method retuns the marksStoreCode of the matching item or null ('') to indicate not found
<li>Item must exactly match the search <var class="term">collectionItem</var> rather than simply containing the search <var class="term">string</var>.
</ul>
==Examples==
==Examples==
==See also==
==See also==
{{Template:MarksStoreArray:Find footer}}
{{Template:MarksStoreArray:Find footer}}

Revision as of 11:09, 18 February 2011

Find next MarksStoreArray item that matches a value (MarksStoreArray class)


Syntax

%string = marksStoreArray:Find( collectionItem, [After= string])

Syntax terms

%string A string variable (length 3) that is set to the marksStoreCode of the first item in the marksStoreArray that matches the search collectionItem, or it is set to Null if the search collectionItem is not found.
marksStoreArray MarksStoreArray object
collectionItem The collectionItem to be matched. This is a required argument.
string A marksStoreCode that indicates the item at which the search is to begin. If this argument is not specified, searching begins at the first item in the MarksStoreArray. The string must be a valid marksStoreCode or the method will return an error.

Usage notes

  • The method retuns the marksStoreCode of the matching item or null () to indicate not found
  • Item must exactly match the search collectionItem rather than simply containing the search string.

Examples

See also