Advantage Client Engine
Determines if the current record is visible.
UNSIGNED32 |
AdsIsRecordVisible (ADSHANDLE hObj, UNSIGNED16 *pbVisible); |
hObj (I) |
Handle of table, cursor, or index order. |
pbVisible (O) |
Return True if the current record is visible, False if not. |
AE_NO_CURRENT_RECORD Data cannot be retrieved from EOF or BOF
AdsIsRecordVisible tests the current record against all record filtering mechanisms. AdsIsRecordVisible will evaluate the current record’s deleted status, verify the record passes the filter expression (if a filter is set), and verify the record passes the AOF expression (if an AOF is set). If the record passes all of these conditions the return value in the pbVisible parameter will be True. If the record fails to pass any of the conditions the return value in the pbVisible parameter will be False. If the hObj parameter is an index order handle AdsIsRecordVisible will in addition to testing against the above filters also verify the record meets all scope and conditional index specifications.
Note The CONTAINS() function (see Full Text Search is not evaluated by this API. It is evaluated as True when evaluated by this API at the client. The cost of performing the text search at the client would be prohibitive. The primary effect of this is that the Advantage TDataSet Descendent will not change the visibility of records when edits are made that would change the result of a CONTAINS() call. The filter or query must be re-executed before the changes will take effect.
AdsIsRecordVisible( hTable, &bVisible );
if ( bVisible )
{
/* process this record */
}