FindAtIndex
Finds a value from a segement field at the given record-set offset.
Syntax
Function FindAtIndex(Field As String, lIndex As Long, DstValue) As Boolean
Parameters
Field |
Required [in]; Specifies the field from where data is to be read. It should not be an empty string |
lIndex |
Required [in]; Specifies the index of the record from which the data is to be read |
DstValue |
Required [out]; Stores the value retrieved from the field |
Return Values
Returns TRUE if it successfully finds the value in the record-set, otherwise FALSE.
Remarks
It retrieves data from a particular field at a given offset in the record-set that is associated with the list engine. The offset is always zero-based (from the beginning of the record-set). This method will perform the search in the existing record-set. If the record-set is not available, it will fetch the data from the database using the business document and segment names for the list engine.
Error Data
Error Code |
Error message |
Reason |
E_BOF_POINTER |
"An invalid (NULL) pointer was passed to the function as a parameter" |
A null parameter was passed |
E_BOF_METHODFAILED |
"FindAtIndex failed." |
Failed to retrieve the records |
E_TL_FLDS_ITEM |
"A specified segment field does not exist in the Record-set." |
The segment field does not exist in the business document segment |
E_LE_NOTINITIALIZED |
"ListEngine is not Initialized. Cannot use the ListEngine." |
When the list engine was created, Initialize failed |
See Also
Find