TrnClientInfo

Cicode Programming Reference > Cicode Function Categories > Trend Functions Introduction > TrnClientInfo

TrnClientInfo

Gets information about the trend that is being displayed at the AN point.

Syntax

TrnClientInfo(AN, Pen, Type, Data, Error)

hAN:

The AN point number at which the trend is displayed.

Pen:

The trend pen number:

0 - The pen currently in focus

1...8 - Pen1. . .Pen8

Type:

The type of information you would like returned.

1 - The number of samples configured for the trend. If you select Type 1, the Data argument is ignored.

Data:

For future enhancements; is currently ignored.

Error:

An output argument. If the function is successful, the error is set to 0 (zero). If unsuccessful, an error value is set, and a hardware alarm is triggered.

Return Value

The requested information (as a string) if successful, otherwise a hardware alarm is generated.

Related Functions

TrnInfo

Example

INT nError;

INT nSamples;

INT nTime;

!Gets the number of samples configured for the current pen of the 
trend displayed at AN 30.

nSamples = TrnClientInfo(30, 0, 1, "", nError);

IF nError = 0 THEN

	nTime = nSamples * 50;

ELSE

	nTime = 0;

END