tcl.comment Verb: Access/TCL


Command tcl.comment Verb: Access/TCL
Applicable release versions: AP
Category TCL (746)
Description performs cursor control and screen display funtions similar to the "t" command in PROC. Its primary funtion is to add screen control capabilities to macro funtions.

Parameters are passed to the "comment" function as discrete units surrounded by parentheses. The following types of text are supported:

(column,row) "x,y" (column,row) positioning
(-n) special cursor control features
(xn) prints the characters whose numeric value is n
(string) prints the string of characters at the current cursor position

Several text segments may be entered on a single "comment" command line, but each must be surrounded by a single pair of parentheses.
The optional "+" at the end of a line suppresses the automatic carriage return and linefeed.
Syntax comment (text){(text2)}{(...)}{+}
Example to clear a screen:

001 n clear-screen macro
002 comment (-1)

A sample "logon" macro:

001 n logon macro
002 comment (-1)(-13)(User Logon)(0,2)(User:)(-14)(20,2)+
003 who
004 comment (0,3)(-13)(Time-Date:)(-14)(20,3)+
005 time
006 comment (0,5)(-13)(Spooler Assignment)(-14)
007 sp-assign ?
008 comment (0,10)(-13)(Terminal Assignment)(-14)
009 term

This example of a "logon" macro clears the screen and displays the 
users name/account, the current date and time, and the current terminal and 
printer assignment parameters.
Related basic.@.functions