GETCOMMENT

Purpose:

Returns the comment string for any series in a Window, including overplots and overlays.

Syntax:

GETCOMMENT(series, item, column)

series

-

Optional. A series. Defaults to the series in the current Window.

item

-

Optional. An integer, the item number. Defaults to 1.

column

-

Optional. An integer, the column number within the specified item. Defaults to 1.

Returns:

A string.

Example:

getcomment(W3)

 

returns the comment of the first series in W3 from the information box.

Remarks:

The comment field for the primary series is displayed in the information box, and can be viewed by pressing [F2] or clicking on the 'I' icon.

The comment is displayed as the column header when in table view.

See Also:

COMMENT

SETCOMMENT