Cicode Programming Reference > Cicode Function Categories > Alarm Functions > AlmBrowseNumRecords

AlmBrowseNumRecords

The AlmBrowseNumRecords 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 AlmBrowseNumRecords(LONG iSession)

iSession:

The handle to a browse session previously returned by a AlmBrowseOpen 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

AlmBrowseAck, AlmBrowseDisable, AlmBrowseEnable, AlmBrowseClose, AlmBrowseFirst, AlmBrowseGetField, AlmBrowseNext, AlmBrowseOpen, AlmBrowsePrev

Example

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

See Also

Alarm Functions

Published June 2018