home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 10 Tools / 10-Tools.zip / samtexco.zip / imolsdef.h < prev    next >
C/C++ Source or Header  |  2002-08-14  |  11KB  |  180 lines
  1. /*====================================================================*/
  2. /*  Name:     IMOLSDEF.H     (Library Services - general definitions) */
  3. /*====================================================================*/
  4. /*                                                                    */
  5. /*  Licensed Materials - Property of IBM                              */
  6. /*                                                                    */
  7. /*  5765-IMT (C) Copyright IBM Corporation 1997, 1998                 */
  8. /*                                                                    */
  9. /*  All rights reserved.                                              */
  10. /*  US Government Users Restricted Rights -                           */
  11. /*  Use, duplication or disclosure restricted by GSA ADP              */
  12. /*  Schedule Contract with IBM Corporation.                           */
  13. /*                                                                    */
  14. /*  See Copyright Instructions.                                       */
  15. /*                                                                    */
  16. /*====================================================================*/
  17. /*                                                                    */
  18. /* Permission Notice                                                  */
  19. /*                                                                    */
  20. /* Permission is granted to copy, use, modify, and merge this         */
  21. /* software into your applications and to permit others to do any of  */
  22. /* the foregoing.                                                     */
  23. /* You may further distribute these object classes for commercial     */
  24. /* purposes only as part of your application that adds significant    */
  25. /* value and function beyond that provided by these object classes.   */
  26. /* You must include this permission statement and retain the          */
  27. /* copyright notice in all copies and modified versions of this       */
  28. /* software.                                                          */
  29. /*                                                                    */
  30. /*====================================================================*/
  31.  
  32. #if !defined(IMOLSDEF_DEFINED)      /* definitions already included ? */
  33. #define IMOLSDEF_DEFINED            /* if not, include them           */
  34.  
  35. #include "imoapic.h"                /* include api header file        */
  36. /*--------------------------------------------------------------------*/
  37. /* Parameter definitions                                              */
  38. /*--------------------------------------------------------------------*/
  39. #define  LS_FIRST     0xC6          /* Start  type                    */
  40. #define  LS_NEXT      0xD5          /* Next   type                    */
  41. #define  LS_CANCEL    0xC3          /* Cancel type                    */
  42.  
  43. #define  LS_TRUE      1             /*                                */
  44. #define  LS_FALSE     0             /*                                */
  45.  
  46. /*--------------------------------------------------------------------*/
  47. /* Return Code values                                                 */
  48. /*--------------------------------------------------------------------*/
  49. #define  RC_OK                                     0
  50. #define  RC_END_OF_FILE                            4
  51. #define  RC_TERMINATION_ERROR                      8
  52.  
  53. #define  RC_NO_ATTRIBUTES_DEFINED                121
  54.  
  55. /*--------------------------------------------------------------------*/
  56. /* Datastream item identifiers for Digital Library library services   */
  57. /*--------------------------------------------------------------------*/
  58. #define  ID_LIBI          45           /* Library access information  */
  59.                                        /* -- library identifier LIBNAM*/
  60.                                        /* -- user_id            UID   */
  61.                                        /* -- password           PWD   */
  62. #define  ID_NLS         620            /* language support            */
  63. #define  ID_DICT        630            /* dictionary type             */
  64. #define     DICT_GENERAL     0x00      /* -- general dictionary       */
  65. #define     DICT_SYNONYMS    0x08      /* -- common synonyms          */
  66. #define     DICT_STOPWORDS   0x09      /* -- common stopwords         */
  67. #define     DICT_ABBR        0x0A      /* -- common abbreviations     */
  68. #define     DICT_X_STOPWORDS 0x19      /* -- index-specific stopwords */
  69. #define  ID_ADDST       640            /* stopword to be added        */
  70. #define  ID_REMST       650            /* stopword to be removed      */
  71. #define  ID_SWT         670            /* stopword table word list    */
  72. /*--------------------------------------------------------------------*/
  73. /* Datastream item identifiers                                        */
  74. /*--------------------------------------------------------------------*/
  75. #define  ID_DGNAM     1001          /* Document group name            */
  76. #define  ID_DOCF      1011          /* Document format                */
  77. #define  ID_DSID      1012          /* Document index status          */
  78.  
  79. #define  ID_DNFND     1021          /* Document not found             */
  80. #define  ID_DNACC     1022          /* Document curr. not accessible  */
  81. #define  ID_DACCD     1023          /* Document access denied         */
  82. #define  ID_DAERR     1024          /* Document access error          */
  83.  
  84. #define  ID_DGNFND    1031          /* Document group not found       */
  85. #define  ID_DGNACC    1032          /* Document group curr. not acc.  */
  86. #define  ID_DGACCD    1033          /* Document group access denied   */
  87. #define  ID_DGAERR    1034          /* Document group access error    */
  88.  
  89. #define  ID_DTRQ      1101          /* Date-time requested            */
  90. #define  ID_DTLM      1102          /* Date-time last modified        */
  91. #define  ID_DTDL      1103          /* Date-time deleted              */
  92. #define  ID_DTIM      1104          /* Date-time timestamp            */
  93.  
  94. #define  ID_ATID      1301          /* Attribute identifier           */
  95. #define  ID_AVAL       460          /* Attribute value                */
  96.  
  97. /*--------------------------------------------------------------------*/
  98. /* Document index status identifiers                                  */
  99. /*--------------------------------------------------------------------*/
  100. #define  DSID_INDX    1501          /* Index status: indexed          */
  101. #define  DSID_NIDX    1502          /* Index status: not indexed      */
  102. #define  DSID_DERR    1503          /* Index status: document error   */
  103. #define  DSID_DXCL    1504          /* Index status: document excluded*/
  104. #define  DSID_UNQA    1505          /* Index status: unqueue ADD doc. */
  105. #define  DSID_UNQR    1506          /* Index status: unqueue REM doc. */
  106. #define  DSID_NFND    1507          /* Index status: document notfound*/
  107. #define  DSID_NACC    1508          /* Index status: doc notaccessible*/
  108.  
  109. /*--------------------------------------------------------------------*/
  110. /* Attribute identifiers                                              */
  111. /*--------------------------------------------------------------------*/
  112. #define  ATID_DESC   "\x44\x53"     /* Attribute id: DS - description */
  113. #define  ATID_DTIME  "\x44\x54"     /* Attribute id: DT - date-time   */
  114. #define  ATID_LOC    "\x4c\x4f"     /* Attribute id: LO - location    */
  115. #define  ATID_NAME   "\x4e\x4d"     /* Attribute id: NM - name        */
  116.  
  117. /*--------------------------------------------------------------------*/
  118. /* Document format identifiers                                        */
  119. /*--------------------------------------------------------------------*/
  120. //
  121. //   Supported Formats:
  122. //
  123. #define  FFT              0x0002    /* DCA:FFT                        */
  124. #define  RFT              0x000B    /* DCA:RFT/E                      */
  125. #define  TDS              0x000E    /* IBM PC Flat ASCII              */
  126. #define  ASCIISECTION     0x0010    /* Flat ASCII with Section Support*/
  127.  
  128. #define  WP5              0x1001    /* WordPerfect 5.x                */
  129. #define  MSWORD           0x1002    /* MS Word                        */
  130. #define  ECTF             0x1003    /* IBM SearchManager/370          */
  131.                                     /* ECTF, codepage 850             */
  132. #define  RTF              0x1004    /* Rich text format (RTF)         */
  133. #define  DSTF             0x1005    /* Own datastream text format     */
  134. #define  AMI              0x1006    /* Lotus Ami Pro Version 4        */
  135. #define  IBMWORKS         0x1007    /* IBM Works / Legato             */
  136. #define  STARWRITER       0x1008    /* Star Writer v1/v2              */
  137. #define  DESCRIBE         0x1009    /* DeScribe 4.0 or higher         */
  138. #define  HTML             0x1042    /* HTML format                    */
  139. #define  XML              0x1043    /* XML format                     */
  140.  
  141. /*--------------------------------------------------------------------*/
  142. /* The EHW_USER_FORMATS defines the starting value of your own        */
  143. /* document formats when the user exit is active. For all values      */
  144. /* greater than EHW_USER_FORMATS, the user exit is called.            */
  145. /* All values lower than EHW_USER_FORMATS are reserved.               */
  146. /*--------------------------------------------------------------------*/
  147.  
  148. #define  EHW_USER_FORMATS 0x2000
  149.  
  150. /*--------------------------------------------------------------------*/
  151. /* Date/time format                                                   */
  152. /*--------------------------------------------------------------------*/
  153. typedef unsigned char LS_DATIME[8]; /* LS date-time field in binary   */
  154.                                     /*    format:   YYMDHmsh          */
  155.                                     /*                                */
  156.                                     /* where YY        = year         */
  157.                                     /*       M         = month        */
  158.                                     /*       D         = day          */
  159.                                     /*       H         = hour         */
  160.                                     /*       m         = minute       */
  161.                                     /*       s         = second       */
  162.                                     /*       h         = 1/100 second */
  163.                                     /*                                */
  164.                                     /* X'0000000000000000' if not     */
  165.                                     /*   existing                     */
  166.  
  167. /*--------------------------------------------------------------------*/
  168. /* Lengths and constants                                              */
  169. /*--------------------------------------------------------------------*/
  170. #define  LEN_DIAGNOSIS_INFO  16     /* length of diagnostic info      */
  171.                                     /* returned by services           */
  172.  
  173.                                     /* LIBRARY (used when scope of    */
  174.                                     /*          LIB_list_doc_groups   */
  175.                                     /*          is entire library)    */
  176. #define  LIBRARY   "\xff\xff\xff\xff"
  177.  
  178. #endif                              /* end of include switch          */
  179.  
  180.