System Functions
CTL( ) Return CTL Definition
   
Format 1. Return CTL Definition: CTL(chan,input[$][,ERR=stmtref])
 
2. Return Input Sequence: CTL(READ chan,ctlval[,ERR=stmtref])
 
Where:
chan Channel or logical file number. Usually 0 (zero), the terminal.
ctlval CTL value whose input sequence is to be returned.
input[$] Input sequence. Either the keyboard character string received or the invalid CTL value. String or numeric expression.
stmtref Program line number or statement label to which to transfer control.
   
Returns CTL code associated with input, or input sequence associated with CTL.
   
Description The CTL( ) function is designed for use in programs that interact directly with the terminal. It provides access to the CTL lookup tables maintained internally in ProvideX.

When an input sequence is passed to CTL( ), it returns the CTL values associated with the input; e.g., PRINT CTL(0,$000002e$) returns -1007. When a CTL value is passed to CTL(READ ..), it returns the input sequence associated with the control.
   
See Also DEFCTL Directive
Negative CTL Definitions
   
Examples The following example reads an uppercase string intoY$ without editing and stops on a CTL value > 0:

0020 OPEN (1) FID(0); Y$=""
0030 READ RECORD (1,SIZ=1)X$
0040 IF X$<" " OR X$=$7F$ THEN GOTO 0100
0050 LET X$=UCS(X$),Y$=Y$+X$
0060 PRINT X$,; GOTO 0030
0100 LET C=CTL(0,X$,ERR=0050); GOTO 0130
0110 READ RECORD (1,SIZ=1)X1$
0120 LET X$=X$+X1$; GOTO 0100
0130 IF C>0 THEN GOTO 1000 ! Found it
0140 LET C=CTL(0,C,ERR=0160) ! Check alternates
0150 GOTO 0130
0160 PRINT 'RB',; GOTO 0030
1000 PRINT "DONE"; STOP

In the example below, the CTL( ) function returns a string value containing a list of control sequences for a specified CTL value. The string is made up of a series of fields where the 1st byte preceding each field indicates the number of characters in the control sequence; the rest of the field shows the actual control sequence. To print control sequences for function keys F1 through F4 :

0010 FOR CTL_CODE=1 TO 4
0020 PRINT 'LF',STR(CTL_CODE:"#0")," ",
0030 LET X$=CTL(READ 0,CTL_CODE)
0040 IF X$="" THEN GOTO 0070
0050 LET X=DEC(X$(1,1)); PRINT PAD(HTA(X$(2,X)),10),
0060 LET X$=X$(X+2); GOTO 0040
0070 NEXT
0080 PRINT " DONE"; STOP
-:RUN
1 000070
2 000071
3 000072

    4 1B 000073 00FF82 DONE
   
If the expression is numeric, ProvideX returns any alternate CTL value that has been assigned; e.g., PRINT CTL(0,$000070$) returns 1 (CTL=1 or the F1 key).