pipt_scan

This function retrieves the scan bit. lscan is TRUE if the scan is on and FALSE if the scan is off. This bit is used by some of the process I/O interfaces. Performance Equations may be turned on or off using their scan attribute. The Totalizer subsystem on PI3 does honor the scan attribute. However, on PI2 the Totalizer does not use the scan attribute.

C format

int32 pipt_scan(

int32 pt,

int32 PIPTR * lscan );

Returns

> 0

System error

0

Success

-1

Point does not exist

Arguments

pt (passed)

Point number

lscan (returned)

true (non-zero) if scan is on, or false (zero) if scan is off or point does not exist

Usage Notes

Enabling Operational Intelligence