Cicode Programming Reference > Cicode Function Categories > Trend Functions > TrnGetFormat

TrnGetFormat

Gets the format of a trend tag being plotted by a specified pen.

Syntax

TrnGetFormat(nAN, Pen, Width, DecPlaces)

nAN:

The AN of the chosen trend.

Pen:

The trend pen number:

0 - The pen currently in focus

1...8 - Pen1. . .Pen8

Width:

Variable denoting the width of the format.

DecPlaces:

Variable denoting the number of decimal places in the format.

Return Value

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

Related Functions

TrnGetScale, TrnGetUnits

Example

/* If the trend tag being plotted by Pen1 of the trend at AN20 has 
a format of "###.#" */
TrnGetFormat(20,1,Width,DecPlaces);
! Sets Width to 5 and DecPlaces to 1.

See Also

Trend Functions

Published June 2018