TrnGetPen

Gets the trend tag being plotted by a specified pen.

Syntax

TrnGetPen(nAN, Pen [, Mode] )

nAN:

The AN of the chosen trend.

Pen:

The trend pen number:

0 - The pen currently in focus

1...8 - Pen1. . .Pen8

Mode:

An optional argument used to specify whether the trend tag name is returned with a cluster prefix. Set:

0 return tag without cluster prefix (default)

1 return tag with cluster prefix.

Return Value

The trend tag (as a string) being plotted by Pen. If nAN or Pen is invalid, an empty string is returned, and an error code is set. You can call the IsError() function to get the actual error code.

Related Functions

TrnSetPen

Example

! For the trend at AN20

DspText(31,0,TrnGetPen(20,0,1));

! Displays the trend tag with cluster prefix of the focus pen.

See Also

Trend Functions