Finds the first exact match or partial match in the index to the passed key.
Syntax
|
bValue = object.brFindFirst(sKey, [vsIId]) |
Parameters
|
Parameter |
Description |
|
bValue |
The return value is a Boolean data type that is True if an exact or partial match to sKey is found in the index. |
|
object |
An object variable that represents a clsD3Index object. |
|
sKey |
A String containing the search string. |
|
vsIId |
Optional. A Variant (String subtype) containing the item-id of the first D3 item whose index matches sKey. This is an output-only parameter that returns the same result as the brIndexId property. |
Remarks
If no match to sKey is found in the index, then the return value is False. The item-id returned is that of the next sequential entry in the index, unless this is past the end of the index.
If sKey is null, then the first entry in the index is returned.
FlashBASIC Reference
D3IndexComKey: key - with the 'c' operator