Find (MarksStoreArray function)

From m204wiki
Revision as of 00:00, 23 February 2012 by JAL2 (talk | contribs) (→‎Syntax terms)
Jump to navigation Jump to search

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 value 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.
After A marksStoreCode that indicates the item at which the search is to begin. If this string argument is not specified, searching begins at the first item in the MarksStoreArray. The string must be a valid MarksStoreCode value 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.
  • Not specifying the After value means search from the start. Specifying an After value of '000' means the same thing. However, '000' is not a valid item code.

Examples

See also