pipt_nextptwsourcelong

This function gets the next point number with a point source which matches the passed point source.

C format

int32 pipt_nextptwsourcelong(

char PIPTR * source,

int32 PIPTR * pt );

Returns

>0

System error

0

Success

-1

No more points with passed source

-10008

Function not supported

Arguments

source (passed)

Point source string (case insensitive)

pt (passed, returned)

Point number

Usage Notes

The source string is not case sensitive - it is internally converted to upper case.

If the argument source is NULL, this function returns all points in the Point Database.

For PI 2 Servers, this search is not supported.

For PI 3 Servers, this search is supported in version 3.4.370 and later. The first call of this function begins searching for a matching point source at point number 1. Subsequent calls return the next point in the Point Database with the given point source.

Example

The following code segment demonstrates how to obtain the point numbers of all of the tags with a given point source:

int32 pt = 0;

int32 status = 0;

char *ptsource = "Random";

while ( !(status = pipt_nextptwsourcelong ( ptsource, &pt ))) {

/* add point number to list, do not modify pt */ 

}

/* check the status return */

if ( status != -1 ) {

/* probably signals a fatal error */ 

}

Enabling Operational Intelligence