home *** CD-ROM | disk | FTP | other *** search
/ Amiga Elysian Archive / AmigaElysianArchive.iso / prog / arexx / dspmod.lha / Docs / STATUS.doc < prev    next >
Encoding:
Text File  |  1990-01-22  |  1.8 KB  |  48 lines
  1.  
  2. NAME:        STATUS
  3.  
  4. SYNTAX:    STATUS
  5.  
  6.      STATUS reports back to the script a number of parameter settings.
  7.      The status report is simply a number of uppercase words in a string
  8.      that tell you some things about the display module's current state.
  9.      The STATUS string is returned in RESULT. OPTIONS RESULTS must have
  10.      previously been issued if you are requesting STATUS from within a
  11.      script.
  12.  
  13. RETURNED VALUES:
  14.  
  15. CONNECTED PORT  - This is the name of the current 'data' port. It is where
  16.                   all your 'normal' keystrokes will be sent.
  17.  
  18. CONTROL PORT    - This is the name of the current control port, which is
  19.                   where all function key and HELP key messages will be
  20.                   sent.
  21.  
  22. WINDOW ADDRESS  - The hexadecimal address of the display module's window.
  23.  
  24. CONSOLE ADDRESS - The hexadecimal address of the display module's
  25.                   console device for writing to the screen.
  26.  
  27.   The last two items are provided for advanced programming, where a
  28. programmer might want to use them for speed reasons, connecting say,
  29. a serial module or a printing routine directly to the console, or a
  30. graphic rendering routine or menus and gadgets directly to the window.
  31.  
  32. NOTE: Though using graphic routines and the console device are probably
  33.       safe enough, the current version of this display module does not
  34.       support menus, gadgets, or mouse events.
  35.  
  36. EXAMPLE:
  37.  
  38.        OPTIONS RESULTS       /* tell ARexx we want result strings */
  39.        ADDRESS 'ROBBS_disp'  /* send all non-ARexx commands to display */
  40.        STATUS                /* ask the display module for status */
  41.        SAY RESULT            /* print the result string */
  42.  
  43.    This would print a string that looks something like this:
  44.  
  45.    ROBBS_ser ROBBS_ctrl 2B3404 2AFF54
  46.  
  47. SEE ALSO: CTRL, CONNECT
  48.