AlmSummaryNumRecords

The AlmSummaryNumRecords function retrieves the number of records in an alarm summary browse session.

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

Syntax

LONG AlmSummaryNumRecords(LONG iSession)

iSession:

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

AlmSummaryAck, AlmSummaryClear, AlmSummaryClose, AlmSummaryDelete, AlmSummaryDeleteAll, AlmSummaryDisable, AlmSummaryEnable, AlmSummaryFirst, AlmSummaryGetField, AlmSummaryLast, AlmSummaryNext, AlmSummaryPrev

Example

INT numRecords = 0;
...

numRecords = AlmSummaryNumRecords(iSession);

IF numRecords <> 0 THEN

// Have records

ELSE

// No records

END

...

See Also

Alarm Functions