Cicode Programming Reference > Cicode Function Categories > Alarm Functions Introduction > AlmTagsNumRecords

AlmTagsNumRecords

The AlmTagsNumRecords 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

AlmTagsNumRecords(iSession)

iSession:

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

AlmTagsAck, AlmTagsClear, AlmTagsDisable, AlmTagsEnable, AlmTagsClose, AlmTagsFirst, AlmTagsGetField, AlmTagsNext, AlmTagsOpen, AlmTagsPrev

Example

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

See Also

Alarm Functions