home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 10 Tools / 10-Tools.zip / ocl150a.zip / OCL / Include / OSysLevel.h < prev    next >
C/C++ Source or Header  |  1996-08-12  |  8KB  |  268 lines
  1. // OCL - OS/2 Class Library
  2. // (c) Cubus 1995
  3. // All Rights Reserved
  4. // OSysLevel.h
  5.  
  6. /*
  7.  * Redistribution and use in source and binary forms, with or without
  8.  * modification, are permitted provided that the following conditions
  9.  * are met:
  10.  * 1. Redistributions of source code must retain the above copyright
  11.  *    notice, this list of conditions and the following disclaimer.
  12.  * 2. Neither the name Cubus nor the name Team OCL may be used to
  13.  *    endorse or promote products derived from this software
  14.  *    without specific prior written permission.
  15.  * 3. See OCL.INF for a detailed copyright notice.
  16.  *
  17.  *              THIS SOFTWARE IS PROVIDED ``AS IS'' AND
  18.  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  19.  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  20.  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  21.  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  22.  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  23.  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  24.  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  25.  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  26.  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  27.  * SUCH DAMAGE.
  28.  */
  29.  
  30.  
  31. // $Header: W:/Projects/OCL/Include/rcs/OSysLevel.h 1.50 1996/08/11 23:47:32 B.STEIN Release $
  32.  
  33.  
  34. /*
  35.  
  36.   The following diagram shows the general format of a syslevel file.
  37.  
  38.      ╔═════════════════════════════╗
  39.      ║ header (SLFHEADER)          ║
  40.      ║       ...                   ║
  41. ┌────╫────── ulTableOffset         ║
  42. │    ║                             ║
  43. │    ╚═════════════════════════════╝
  44. │
  45. │
  46. └──>>╔═════════════════════════════╗
  47.      ║ SYSTABLE                    ║
  48.      ║       ...                   ║
  49.      ║       ...                   ║
  50.      ║       ...                   ║
  51.      ╚═════════════════════════════╝
  52.    **╔═════════════════════════════╗
  53.      ║ Updated directory list      ║
  54.      ║       ...                   ║
  55.      ║       ...                   ║
  56.      ║       ...                   ║
  57.      ╚═════════════════════════════╝
  58.  
  59.    ** Added after successful service
  60.  
  61. */
  62.  
  63.  
  64. #ifndef OSYSLEVEL_H_INCLUDED
  65.   #define OSYSLEVEL_H_INCLUDED
  66.  
  67.  
  68. // SLFHEADER - This structure contains the information in a
  69. //             SYSLEVEL file header.  The first 2 fields are used
  70. //             to verify that the file is actually a SYSLEVEL file.
  71. //             Also identified is the version, date, and offset to
  72. //             the SYSTABLE information -- see SYSTABLE
  73.  
  74.  
  75. #pragma pack(1)
  76.  
  77. typedef struct _SLFHEADER
  78. {
  79.  USHORT    usSignature;          // special # for id of syslevel file
  80.  CHAR      achSignature[8];      // id, must be 'SYSLEVEL'
  81.  CHAR      achJulian[5];         // date of version
  82.  USHORT    usSlfVersion;         // version of syslevel file, must be 1
  83.  USHORT    ausReserved[8];       // reserved
  84.  ULONG     ulTableOffset;        // offset of SYSTABLE
  85. } SLFHEADER, *PSLFHEADER;
  86.  
  87.  
  88. // SYSTABLE - This structure contains the information about
  89. //            a specific component of a particular system. This
  90. //            info includes date and level information about the
  91. //            system /subsystem and the particular component.
  92.  
  93. // defines for bSysEdition field
  94.  
  95. #define SYSED_SE         0x00     // os/2 standard edition
  96. #define SYSED_EE         0x01     // os/2 extended edition
  97. #define SYSED_ES         0x02     // os/2 extended services
  98. #define SYSED_GENERAL    0x0F     // all others
  99.  
  100.  
  101. typedef struct _SYSTABLE
  102. {
  103.  USHORT    usSysId;               // identifies system/subsytem
  104.  BYTE      bSysEdition;           // edition of system, eg SE=00, EE=01
  105.  BYTE      bSysVersion;           // version, eg 1.00=10, 1.10=11
  106.  BYTE      bSysModify;            // modify, eg 1.00=00, 1.01=01
  107.  USHORT    usSysDate;             // date of system
  108.  CHAR      achCsdLevel[8];        // subsytem CSD level, eg, XR?0000_
  109.  CHAR      achCsdPrev[8];         // as above, except for prev system
  110.  CHAR      achSysName[80];        // Title of system / subsytem (ASCIIZ)
  111.  CHAR      achCompId[9];          // component ID of subsytem
  112.  BYTE      bRefreshLevel;         // eg, for version 1.30.1, use 1
  113.  BYTE      bReserved;             // reserved, must be 0
  114.  CHAR      achType[9];            // Null terminated type (8 chars +'\0')
  115.  BYTE      usReserved[6];         // reserved, must be 0
  116. } SYSTABLE, *PSYSTABLE;
  117.  
  118.  
  119. #pragma pack()
  120.  
  121. /*
  122.  
  123. Detailed SYSTABLE Field Descriptions
  124. ------------------------------------
  125.  
  126.   This is a number that is assigned to each product that is supported for
  127. service.
  128.  
  129.   Currently assigned SYSIDs:
  130.  
  131.      SYSID   EXTENSION    (partial list)
  132.      -----   ---------
  133.  
  134.   [note:  other SYSIDs in the range A0x0 - F0x0 are used by IBM]
  135.  
  136.      C010  -    LMU   LAN Manager Utilities/2
  137.      C020  -    X25   IBM X25 Net Manager
  138.      C040  -    OSI   Communications Subsystem For OS/2 EE
  139.      C060  -    SNP   IBM Snap Dump
  140.      C070  -    ISB   ISDN Coprocessor Support Program Version 1.2
  141.      C080  -    CS2   C SET/2
  142.      C081  -    WF2   Work Frame/2
  143.      1000  -          OS/2 SE
  144.      1010  -          OS/2 Toolkit
  145.      2000  -          OS/2 Comm Mgr
  146.      2010  -          OS/2 Feature group 1  (3270 emulator)
  147.      2020  -          OS/2 Feature group 2  (Async)
  148.      4000  -          OS/2 Database Mgr
  149.      4010  -          OS/2 Query Mgr
  150.      5000  -          OS/2 LAN Requester
  151.      5010  -          OS/2 LAN Server
  152.  
  153.  
  154. bSysEdition
  155. -----------
  156.  
  157.   A number between 0 and 255 (x0-xFF) that represents the type 
  158. of product being serviced.
  159.  
  160.   OS/2 Standard Edition is 0
  161.   OS/2 Extended Edition is 1
  162.   OS/2 Extended Services is 2
  163.   All other products are classified with a general sysedition of 15 (x0F)
  164.  
  165. bSysVersion
  166. -----------
  167.  
  168.   A number between 1 and 255 (x1-xFF) that represents the
  169. major and minor version of the product being serviced.
  170.   The hi-order byte is the major version.  The lo-order byte is the
  171. minor version.  For example:
  172.  
  173.   version 1.0, use x10
  174.   version 1.1, use x11
  175.   version 2.0, use x20
  176.  
  177. bSysModify
  178. ----------
  179.  
  180.   This is a number between 0 and 255 (x0-xFF) that represents a
  181. modification version (eg, 2.01 is major version 2, minor version 0,
  182. and modify version 1)
  183.  
  184. usSysDate   
  185. ---------
  186.  
  187.   This date is the date of the product.
  188. This is represented by a 16-bit bitfield as follows (FDATE):
  189.  
  190.   unsigned day     : 5;
  191.   unsigned month   : 4;
  192.   unsigned year    : 7;
  193.  
  194. achCsdLevel
  195. -----------
  196.  
  197.   This field is very important.  It specifies the level of the product.
  198. It must be exactly 8 characters with underscore ('_') as its last
  199. character.
  200.   The first two characters are specific to the product:
  201.  
  202.   OS/2 Standard Edition - XR
  203.   OS/2 Extended Edition - WR
  204.  
  205.   The third character represents the country:
  206.  
  207. 0 - United States (Note: This is the digit zero, not letter O)
  208. C - Canada (French speaking)
  209. D - Denmark
  210. F - France
  211. G - German
  212. H - Netherlands
  213. I - Italy
  214. J - Japan
  215. L - Finland
  216. N - Norway
  217. P - Portugal
  218. S - Spain
  219. U - United Kingdom
  220. W - Sweden
  221.  
  222. achCsdPrev
  223. ----------
  224.  
  225.   This represents the previous level of the system and has the same
  226. form as achCsdLevel.  For an initial release, this should be the same
  227. as achCsdLevel.
  228.  
  229. achSysName
  230. ----------
  231.  
  232.   This is the translated name of the system.  This must be null-
  233. terminated and has a maximum length of 80 characters.
  234.  
  235. achCompId
  236. ---------
  237.  
  238.   This is a 9-digit ascii number that represents sub-products.
  239.   For IBM OS/2 Base Operating System, this is 560109001.
  240.  
  241. bRefreshLevel
  242. -------------
  243.  
  244.   This represents the refresh level.  This field is not matched
  245. by the service tool, but is displayed from syslevel.exe.
  246.   For version 1.30.1, use 1 for bRefreshLevel.
  247.  
  248. achType
  249. -------
  250.  
  251.   This field contains an optional, NULL terminated alphanumeric type that is
  252. defined by the application.  This field is only used by the OS/2 2.0 version
  253. of SYSLEVEL.EXE.  The OS/2 1.3 SYSLEVEL.EXE will ignore this field.  If
  254. no type is desired, this field must be all zero's (0).  Because the field is
  255. NULL terminated, it has a maximum length of 8 characters (+ NULL = 9).
  256.  
  257. usReserved
  258. ----------
  259.  
  260. All reserved fields must be zero (0).
  261.  
  262. */
  263.  
  264. #endif // OSYSLEVEL_H_INCLUDED
  265.  
  266.  
  267. // end of source
  268.