home *** CD-ROM | disk | FTP | other *** search
/ World of Shareware - Software Farm 2 / wosw_2.zip / wosw_2 / PASCAL / OVERXMS.ZIP / READ.ME < prev   
Text File  |  1992-05-05  |  3KB  |  78 lines
  1. READ.ME  --  Loading Overlays in XMS
  2.  
  3. Files
  4. -----
  5.  
  6. Apart from this notice, the following files should be present in this
  7. archive:
  8.  
  9. OVERXMS.ASM           Source code of XMS overlay support.
  10. OVERXMS.OBJ           Object code of XMS overlay support.
  11. OVERXMS.PAS           Declares OvrInitXMS.
  12.  
  13. Purpose
  14. -------
  15.  
  16. This package is for users of Turbo Pascal, version 5.0 or later.
  17. These three files are all you need to add XMS support to overlaying.
  18. If you think you can use it, then I probably don't have to explain
  19. what the benefits are of using XMS memory over EMS memory - or
  20. emulations thereof.  But I will anyway:
  21.  
  22. -  XMS is found on more machines than EMS.
  23. -  All XMS is addressable as one physical unit, not in chunks of 16 kB
  24.    like EMS.
  25. -  XMS is faster.  How much faster, depends on the kind of system.
  26.    It probably doesn't matter much on 386/486 systems, but the speedup
  27.    is noticable on a 286 with emulated EMS.  Or if you have a typical
  28.    1 MB 286 clone, configured as 640+384, without either board EMS or
  29.    emulated EMS (served by e.g. Quarterdeck's QRAM memory manager),
  30.    then thanks to OVERXMS you'll have fast loading overlays at last.
  31.  
  32. ... and last but not least:
  33. -  OVERXMS is compact.  It adds a mere 425 bytes of code to your .EXE
  34.    file.
  35.  
  36. Using OVERXMS
  37. -------------
  38.  
  39. Usage is straightforward.  Just change the "uses" clause, so that it
  40. includes OVERXMS.  Next, spot the line wherein you initialise the
  41. overlay manager.  Add two lines, so that it will run something like:
  42.  
  43.     OverInit(YourApplication);
  44.     OvrInitXMS;
  45.     If OvrResult <> OvrOk Then
  46.       OvrInitEMS;
  47.  
  48. That's all.  First, we check whether we can load the overlay into XMS;
  49. if we don't succeed, we resort to EMS allocation and suffer a slight
  50. loss of performance; if no EMS is available, though luck -- continue
  51. with overlays on disk.
  52.  
  53. Status codes
  54. ------------
  55.  
  56. Possible return codes from OverInitXMS are:
  57.   OvrOk           (0)      ... success
  58.   OvrIOError     (-4)      ... something went wrong whilst reading the
  59.                                overlay from disk
  60.   OvrNoXMSDriver (-7)      ... there's no XMS on this system
  61.   OvrNoXMSMemory (-8)      ... there's insufficient XMS memory available
  62.  
  63. History
  64. -------
  65.  
  66. 1.00     - First version May 5, 1992.
  67.  
  68. Author
  69. ------
  70.  
  71. Wilbert van Leijen    Fidonet 2:500/12.10956
  72. Marathonweg 72-2
  73. NL-1076 TM Amsterdam
  74. The Netherlands
  75.  
  76.  
  77. OVERXMS is, with source code and all, donated to the public domain.
  78.