EquipBrowseNumRecords | Equipment Database Functions

Cicode Programming Reference > Cicode Function Categories > Equipment Database Functions > EquipBrowseNumRecords

EquipBrowseNumRecords

The EquipBrowseNumRecords function returns the number of records that match the filter criteria.

This function is a non-blocking function. It does not block the calling Cicode task.

Syntax

LONG EquipBrowseNumRecords(LONG Session)

Session:

The handle to a browse session previously returned by a EquipBrowseOpen call.

Return Value

The number of records that have matched the filter criteria. A value of 0 denotes that no records have matched. A value of -1 denotes that the browse session is unable to provide a fixed number. This may be the case if the data being browsed changed during the browse session.

Related Functions

EquipBrowseClose, EquipBrowseFirst, EquipBrowseGetField, EquipBrowseNext, EquipBrowseOpen, EquipBrowsePrev, EquipCheckUpdate, EquipGetProperty

Example

INT numRecords = 0;
...
numRecords = EquipBrowseNumRecords(iSession);
IF numRecords <> 0 THEN
    // Have records
ELSE
    // No records
END
...