M_KEYTXT

Get shortcut text

WTSupported in traditional Synergy on Windows
WNSupported in Synergy .NET on Windows
USupported on UNIX
VSupported on OpenVMS
xcall M_KEYTXT(function_code, text[, length]) 

Arguments

function_code

The function code number for the shortcut key. (n)

text

Returned with the shortcut text. (a)

length

(optional) Returned with the length of the shortcut text. (n)

Discussion

M_KEYTXT returns the shortcut text associated with a function code number for the current terminal key map. The inpctl.def file defines the associated function code numbers. Key function codes are in the range 1 to 98 (CTRL_A_KEY through F63_KEY).

Text is loaded left‑justified with trailing blanks. If text is too small for the shortcut text, only the leftmost portion is loaded and no warning is given. The shortcut text may be from one to five characters in length.

You may want to create an include file to define mnemonics for the function codes that you use in your key maps (F1_KEY through F63_KEY) that indicate their function (for example, HELP_KEY, EXIT_KEY), and use these mnemonics when calling this routine directly.

Examples

The following subroutine obtains the shortcut text for the “Help” shortcut and then displays it on the information line.

subroutine info_bar 
record msg 
        ,a*     ,"Press " 
  key           ,a5 
        ,a*     ," for help" 
.include "codes.def"            ;User written file
 
proc
  xcall m_keytxt(HELP_KEY, key) 
  xcall e_sect(D_INFO, msg) 
  xreturn
endsubroutine