TrnGetDefScale

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

TrnGetDefScale

Gets the default engineering zero and full scales of a trend tag.

This function is a blocking function. It will block the calling Cicode task until the operation is complete.

Syntax

TrnGetDefScale(Tag, LoScale, HiScale [, ClusterName] )

Tag:

The trend tag enclosed in quotation marks "" (can be prefixed by the name of the cluster that is "ClusterName.Tag").

LoScale:

The engineering zero scale.

HiScale:

The engineering full scale.

ClusterName:

The name of the cluster in which the trend tag resides. This is optional if you have one cluster or are resolving the trend via the current cluster context. The argument is enclosed in quotation marks "".

Return Value

0 (zero) if successful, otherwise an error is returned.

Related Functions

TrnGetScale, TrnInfo

Example

REAL LoScale;

REAL HiScale;

TrnGetDefScale("PV1",LoScale,HiScale,"ClusterXYZ");

/* Returns engineering zero and full scales of the trend tag 
"PV1". */