home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 10 Tools / 10-Tools.zip / validat1.zip / README.DOC < prev    next >
Text File  |  1994-04-21  |  5KB  |  124 lines
  1.                      Validator for OS/2
  2.                         README File
  3.                     Release Notes for the
  4.             Version 1.0  Developer Connection Beta
  5.                       OS/2 2.x Series
  6.           Copyright (c) Prominare Inc., 1992, 1993, 1994
  7.  
  8. This document contains release notes for Version 1.0 of the 
  9. Validator for OS/2. 
  10.  
  11. ====================== < Contents > ========================
  12.  
  13. This file has 7 parts:
  14.  
  15.         Part            Content
  16.         ----            -------
  17.         1               Documentation
  18.         2               Feedback
  19.         3               Header Usage
  20.         4               OS/2 2.0, 2.1 and 2.11
  21.         5               ViewPort Considerations
  22.         6               Compiler Differences
  23.         7               Problem Determination
  24.  
  25. =================== < Documentation > =======================
  26.  
  27. Hard copy documentation is not provided with this beta.
  28. Online documentation is provided through the installation and
  29. is found within the Validator folder.  The PostScript
  30. versions of the documentation are provided on the CD-ROM
  31. but not copied your to system.
  32.  
  33. Two files are provided in the PostScript format:  ParmErrs.PS
  34. and Validatr.PS.  If you have a PostScript compatible printer,
  35. you only need to copy the files to the printer through an
  36. OS/2 command prompt like the following from the CD-ROM:
  37.  
  38. copy \devtools\valbeta\*.ps lpt1:
  39.  
  40. ====================== < Feedback > =========================
  41.  
  42. Validator is based on the released documentation for OS/2.
  43. There may situations where you existing usage of an OS/2 API
  44. works but is failed by the validation routines.  If you feel
  45. that this is incorrect, please post a note within the
  46. Developer Connection area of the OSDF2 Forum on CompuServe.
  47. Please make sure you denote the API and the parameter AND
  48. how you are using it.  This will allow for a response to
  49. your note to be made indicating whether or not the usage is
  50. correct and what the resolution will be.  
  51.  
  52. ==================== < Header Usage > =======================
  53.  
  54. It is extremely important that you use the method of 
  55. including the OS/2 API's through the os2.h, os2me.h and
  56. penpm.h and INCL_* mechanism.  The validation headers depend
  57. on this mechanism to be able to properly redefine the API's
  58. in certain cases.
  59.  
  60. Some of the samples as provided with the various toolkits,
  61. like MMPM/2, ignore this mechanism and will include the 
  62. individual header files even though the toolkit documentation
  63. recommends not doing this.
  64.  
  65. If you use a similar method, you may encounter compiler
  66. errors where the compiler indicates an error in redefining
  67. a function.
  68.  
  69. =============== < OS/2 2.0, 2.1 and 2.11 > ==================
  70.  
  71. The software has been tested on both OS/2 Version 2.0,
  72. OS/2 Version 2.1 and OS/2 Version 2.11.  The newer OS/2
  73. Version 2.1 calls have been added to allow these calls to be
  74. monitored as well.  The calls have been placed within a
  75. separate set of DLL's to ensure that you can still run the
  76. software on OS/2 Version 2.0 systems.
  77.  
  78. =============== < ViewPort Considerations > ================
  79.  
  80. Before you start your application that has been enabled for
  81. ViewPort support, ViewPort MUST be started otherwise
  82. you will receive a message stating that the link between
  83. the Validator DLL and ViewPort was not made.
  84.  
  85. ================ < Compiler Differences > ==================
  86.  
  87. There are differences in how the various compilers generate
  88. code that calls OS/2 functions.  The compilers are
  89. supposed to to place the number of parameters that have been
  90. placed on the stack for the call in the AL register.  The
  91. only compilers that appear to be doing this are the IBM
  92. C Set/2 and C Set++ compilers.  The Borland compiler does
  93. not do this.
  94.  
  95. Therefore, you must specify during the installation which
  96. compiler you are using.  If you are using the IBM compilers,
  97. you should select the IBM compilers radio button otherwise
  98. select the Borland radio button.  This means the feature of
  99. determining if there are too many or few parameters being
  100. passed to the OS/2 API will only occur with the IBM
  101. compilers.
  102.  
  103. ================ < Problem Determination > =================
  104.  
  105. If a problem occurs within an application utilizing the
  106. Validator or ViewPort that causes a memory protection
  107. violation, a message will be displayed showing the memory
  108. address where the violation occurred.  Further information
  109. will be found within the directory where the Validator files
  110. were installed within specific files associated with each
  111. application:
  112.  
  113. Application             Exception File
  114. ---------------------------------------------
  115. Application             Validatr.XCP
  116. ViewPort                ViewPort.XCP
  117. =============================================
  118.  
  119. When a memory protection violation does occurr, please
  120. post a note within the Developer Connection area of the
  121. OSDF2 Forum on CompuServe  with the information produced
  122. in one of the files to allow the support personnel to
  123. help you solve the problem.
  124.