HTGetPenName() Function
- Last UpdatedFeb 22, 2017
- 1 minute read
The HTGetPenName() function returns the name of the tag currently assigned to the specified pen number of the historical trend.
Category
Historical
Syntax
MessageResult=HTGetPenName(Hist_Tag,UpdateCount, PenNum);
Arguments
Hist_Tag
HistTrend tag assigned the name of the trend.
UpdateCount
Integer representing the trend's .UpdateCount dotfield. The argument value acts as a data change trigger to re-evaluate the function
PenNum
Integer tag or value representing the pen number (1-8) of the trend.
Example
The following statement retrieves the name of the tag assigned to Pen 2 of the Trend1 trend and places the name in the TrendPen message tag:
TrendPen=HTGetPenName("Trend1", Trend1.UpdateCount,2);