Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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 The SRP_FastArray_Match method will begin searching at the position specified in the FieldPos, ValuePos, and SubValuePos parameters. Set these to 1, or 0, to search from the beginning of the array. However, if you need to start the search elsewhere, then set the position in advance. For example, setting FieldPos to 3 tells the Match service to start looking for matches in field 3.

Examples

Code Block
// 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)