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

TrnGetPeriod

Gets the current display period of a trend. (To obtain the sampling period, use the TrnInfo function.)

Syntax

TrnGetPeriod(AN)

AN:

The AN of the chosen trend.

Return Value

The current display period of a trend (in seconds), or 0 (zero) if an error is detected.

Related Functions

TrnSetPeriod, TrnInfo

Example

/* For the trend at AN20, get and display the current display 
period. */
! If the period is 10 seconds
INT Period;
STRING Str;
Period=TrnGetPeriod(20);
Str=TimeToStr(Period,5);
DspStr(31,"",Str);

See Also

Trend Functions