Finds the first element to match a given string.
Syntax
SRP_FastArray_Match(Handle, StringToMatch, FieldPos, ValuePos, SubValuePos, MatchAnywhereFlag)
Parameters
| Parameter | Description |
|---|---|
| Handle | Handle to an existing SRP Fast Array (REQUIRED) |
| StringToMatch | The string containing the text you are trying to find. |
| FieldPos | The field position, if found, of the match. |
| ValuePos | The value position, if found, of the match. |
| SubValuePos | The sub-value position, if found, of the match. |
| MatchAnywhereFlag | If true, the match can occur anywhere in an element. Otherwise, only exact matches count. |
Remarks
The SRP_FastArray_Match method locates an element within the list that matches the given string. The match is not case sensitive, but if the MatchAnywhereFlag is false (which is the default), then a match succeeds only when the string matches the entire element. If the MatchAnywhereFlag is true, then the first element contain the given string anywhere within itself is a match. For example, "Branded" is considered a match for "AND" because "and" appears within the element. When a match is found, the FieldPos, ValuePos, and SubValuePos parameters are set to the position of the match. If no match is found, all three parameters will be set to 0.
IMPORTANT: You should always release the handle to an SRP Fast Array when you no longer need it by calling SRP_FastArray_Release.
Examples
// Create a fast array
Handle = SRP_FastArray_Create("Apple":@FM:"Banana":@FM:"Carrot")
// Find banana
FieldPos = 0
ValuePos = 0
SubValuePos = 0
SRP_FastArray_Match(Handle, "banana", FieldPos, ValuePos, SubValuePos, 0)
// Result: FieldPos = 2, ValuePos = 1, SubValuePos = 1
// Find Doughnut
FieldPos = 0
ValuePos = 0
SubValuePos = 0
SRP_FastArray_Match(Handle, "doughnut", FieldPos, ValuePos, SubValuePos, 0)
// Result: FieldPos = 0, ValuePos = 0, SubValuePos = 0
// Find App anywhere
FieldPos = 0
ValuePos = 0
SubValuePos = 0
SRP_FastArray_Match(Handle, "app", FieldPos, ValuePos, SubValuePos, 1)
// Result: FieldPos = 1, ValuePos = 1, SubValuePos = 1
// All done
Variable = SRP_FastArray_Release(Handle)
