PWB Extensions Help (ext.hlp) (Table of Contents; Topic list)
Important Notice
The pages on this site contain documentation for very old MS-DOS software, purely for historical purposes. If you're looking for up-to-date documentation, particularly for programming, you should not rely on the information found here, as it will be woefully out of date.
ReadCmd
                                             Up Contents Index Back
─────PWB Extensions─────────────────────────────────────────────────────────
 
  Syntax:  PCMD ReadCmd( void );
 
  Returns: A pointer to a cmdDesc structure.
 
  See:     pCmdPrompt, ReadChar, Command Table
 
     ReadCmd allows you to obtain information about the function
     assigned to a specific key, including the type of arguments
     accepted by the function. ReadCmd or pCmdPrompt can be used to
     emulate some of the functionality of the Tell function.
     See: PWB Tell function
 
     When ReadCmd is invoked, it waits for a keystroke. The next
     keystroke is translated into a function reference (according to
     current assignments), but the function is not executed. Instead,
     PWB returns a pointer to a PCMD type containing information about
     the function.
     See: PCMD
 
     Once intercepted, the keystroke cannot be given back to PWB for
     execution. For an example that uses the ReadCmd function, see the
     ISEARCH.C and UREPEAT.C sample extensions.
 
     WARNING: Do not modify the structure. Doing so yields unpredictable
              results and could damage your files.
                                    -♦-