Find (MarksStoreArray function): Difference between revisions
Jump to navigation
Jump to search
m (→Syntax terms) |
m (→Usage notes) |
||
| (11 intermediate revisions by 3 users not shown) | |||
| Line 3: | Line 3: | ||
==Syntax== | ==Syntax== | ||
{{Template:MarksStoreArray:Find syntax}} | {{Template:MarksStoreArray:Find syntax}} | ||
===Syntax terms=== | ===Syntax terms=== | ||
<table class="syntaxTable"> | <table class="syntaxTable"> | ||
<tr><th>%string </th> | <tr><th>%string </th> | ||
<td>A string variable (length 3) that is set to the | <td>A string variable (length 3) that is set to the <var>[[MaxStoreCode (MarksStoreArray function)|MaxStoreCode]]</var> value of the first item in the <var>marksStoreArray</var> that matches the search <var class="term">collectionItem</var>, or it is set to null if the search <var class="term">collectionItem</var> is not found. </td></tr> | ||
<tr><th>marksStoreArray</th> | <tr><th>marksStoreArray</th> | ||
<td><var>MarksStoreArray</var> object</td></tr> | <td><var>MarksStoreArray</var> object</td></tr> | ||
<tr><th> | <tr><th>collectionItem </th> | ||
<td> | <td>The <var class="term">collectionItem</var> to be matched. This is a required argument. </td></tr> | ||
<tr><th> | <tr><th><var>After</var></th> | ||
<td> | <td>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 <var>MarksStoreArray</var>. The string must be a valid <var>MaxStoreCode</var> value or the method will return an error.</td></tr> | ||
</table> | </table> | ||
==Usage notes== | ==Usage notes== | ||
<ul> | |||
<li>The method retuns the <var>MaxStoreCode</var> value 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>. | |||
<li>Not specifying the <var>After</var> value means search from the start. Specifying an <var>After</var> value of '000' means the same thing. However, '000' is not a valid item code. | |||
</ul> | |||
==Examples== | ==Examples== | ||
==See also== | ==See also== | ||
{{Template:MarksStoreArray:Find footer}} | {{Template:MarksStoreArray:Find footer}} | ||
Latest revision as of 00:03, 23 February 2012
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 MaxStoreCode 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 MaxStoreCode value or the method will return an error. |
Usage notes
- The method retuns the MaxStoreCode value 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.