Please ensure Javascript is enabled for purposes of website accessibility
Powered by Zoomin Software. For more details please contactZoomin

AVEVA™ Plant SCADA

AlmBrowseNumRecords

  • Last UpdatedJul 18, 2023
  • 1 minute read

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.

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

In This Topic
Related Links
TitleResults for “How to create a CRG?”Also Available in