rexxhelp.c
上传用户:andy_li
上传日期:2007-01-06
资源大小:1019k
文件大小:7k
源码类别:

压缩解压

开发平台:

MultiPlatform

  1. /* rexxhelp.c */
  2. #if defined(API_DOC) && defined(OS2DLL)
  3. #define UNZIP_INTERNAL
  4. #include "../unzip.h"
  5. #include "../version.h"
  6. APIDocStruct REXXDetails[] = {
  7.   { "UZDROPFUNCS"  , "UZDropFuncs"  ,
  8.                "call UZDropFuncs",
  9.                "Use this function to drop all the loaded UnZip functions.n"
  10. "ttOnce this function is processed by a REXX program, then"
  11. "ttUnZip functions are not accessible in any OS/2 sessions.n" },
  12.   { "UZLOADFUNCS"  , "UZLoadFuncs"  ,
  13.                "call UZLoadFuncs",
  14.                "Use this function to make all of the UnZip functionsn"
  15. " in this package available to all OS/2 sessions.nn"
  16. "  Example: call RxFuncAdd 'UZLoadFuncs', 'UNZIPAPI', 'UZLoadFuncs'n"
  17. " call UZLoadFuncsn" },
  18.   { "UZFILETREE"   , "UZFileTree"   ,
  19.                "rc = UZFileTree(zipfile, stem, [include], [exclude], [options])nn"
  20. " zipfile - Name of ZIP file to searchn"
  21. " stem - Name of the stem variable for resultsn"
  22. "   Note: stem.0 contains the number of files found.n"
  23. " include - Optional stem variable specifying a list of files (includingn"
  24. "   wildcards) to include.  stem.0 must indicate number of items.n"
  25. " exclude - Optional stem variable specifying a list of files (includingn"
  26. "   wildcards) to exclude.  stem.0 must indicate number of items.n"
  27. "     NOTE: If lists are not needed, filespec strings may be passed.n"
  28. " options - One of the following:n"
  29. "   'O' - Give file names only.  This is the default.n"
  30. "   'F' - Give file statistics in the form:n"
  31. " Length Date Time Namen"
  32. "   'Z' - Also give ZIP statistics in the form:n"
  33. " Length Method Size Ratio Date Time CRC-32 Name",
  34.                "Finds all files in the specified ZIP with the specifiedn"
  35. " filespec and places their descriptions in a stem variable.nn"
  36. " rc: Return codesn"
  37. " 0 Successfuln"
  38. " 2 Error.  Not enough memory.nn"
  39. " Examples:n"
  40. " /* Return a list of all .NDX files in pcboard.qwk */n"
  41. " rc = UZFileTree('pcboard.qwk', 'stem.', '*.ndx')nn"
  42. " /* Return a list of all files except *.NDX and *.DAT */n"
  43. " exc.0 = 2; exc.1 = '*.ndx'; exc.2 = '*.dat'n"
  44. " rc = UZFileTree('pcboard.qwk', 'stem.',,'exc.')n" },
  45.   { "UZUNZIP"      , "UZUnZip"      ,
  46.                "rc = UZUnZip('parameters', [stem])nn"
  47. " parameters - The entire list of parameters you would use fromn"
  48. "   the command-linen"
  49. " stem - The name of an optional stem variable where anyn"
  50. "   output should be redirected.n"
  51. "   NOTE: If a stem is not specified, all output willn"
  52. " go to the console.",
  53.                "Provide a direct entry point to the command line interface.nn"
  54. " rc: UnZip return codenn"
  55. "  Examples: /* Test the archive 'unzip51s.zip' and return output in stem.*/n"
  56. " rc = UZUnZip('-t unzip51s.zip','stem.')n"
  57. " /* Extract the archive, display output on screen */n"
  58. " call UZUnZip 'doom.zip'n"
  59. " /* Extract all .NDX files from the archive */n"
  60. " call UZUnZip 'pcboard.qwk *.ndx','stem.'n" },
  61.   { "UZUNZIPTOVAR" , "UZUnZipToVar" ,
  62.                "rc = UZUnZipToVar('zipfile', 'filename', [stem])nn"
  63. " zipfile  - Name of ZIP file to searchn"
  64. " filename - Name of file to extract from zipfilen"
  65. " stem  - Optional stem variable to extract the file to.n"
  66. "    If you specify a stem variable, the file will be extractedn"
  67. "    to the variable, one line per index, stem.0 containing an"
  68. "    line count.  In this case, 0 will be returned in rc.n"
  69. "    If NO stem variable is specified, the entire file will ben"
  70. "    extracted to rc.",
  71.                "Unzip one file to a variable.nn"
  72. " rc: If no stem variable is specified, rc contains the contents ofn"
  73. " the extracted file if successful or an error-code if not.n"
  74. " If a stem variable IS specified, rc contains 0 if successful.n"},
  75.   /* GRR:  "include" and "exclude" used to be identified as stem variables
  76.    *       (Daniel H bug report)
  77.    */
  78.   { "UZUNZIPTOSTEM", "UZUnZipToStem",
  79.                "rc = UZUnZipToStem(zipfile, stem, [include], [exclude], [mode])n"
  80. " zipfile - Name of ZIP file to searchn"
  81. " stem - Stem variable used to store the extracted filesn"
  82. " include - Optional string variable specifying a list of files (includingn"
  83. "   wildcards) to include.  stem.0 must indicate number of items.n"
  84. " exclude - Optional string variable specifying a list of files (includingn"
  85. "   wildcards) to exclude.  stem.0 must indicate number of items.n"
  86. "     NOTE: If lists are not needed, filespec strings may be passed.n"
  87. " mode - Optional mode parameter specifies either 'F'lat (the default)n"
  88. "   or 'T'ree mode.n"
  89. " -- In flat mode, each file is stored in stem.fullname i.e.n"
  90. "    stem.os2/dll/unzipapi.c.  A list of files is created inn"
  91. "    stem.<index>n"
  92. " -- In tree mode, slashes are converted to periods in then"
  93. "    pathname thus the above file would have been stored inn"
  94. "    stem.OS2.DLL.unzipapi.c and an index stored for eachn"
  95. "    directory, i.e. stem.OS2.DLL.<index> = "unzipapi.c",n"
  96. "    stem.OS2.<index> = "DLL/", stem.<index> = "OS2/"",
  97.                "Unzip files to a stem variable.nn"
  98. " Example: Assuming a file unzip.zip containing:n"
  99. "   unzip.c, unshrink.c, extract.c,n"
  100. "   os2/makefile.os2, os2/os2.cn"
  101. "   os2/dll/dll.def, os2/dll/unzipapi.cnn"
  102. " rc = UZUnZipToStem('unzip.zip', 'stem.')n"
  103. " Returns: stem.0 = 7n"
  104. " stem.1 = unzip.cn"
  105. " stem.2 = unshrink.cn"
  106. " stem.3 = extract.cn"
  107. " stem.4 = os2/makefile.os2n"
  108. " stem.5 = os2/os2.cn"
  109. " stem.6 = os2/dll/dll.defn"
  110. " stem.7 = os2/dll/unzipapi.cn"
  111. " And the following contain the contents of then"
  112. " various files:n"
  113. " stem.unzip.cn"
  114. " stem.unshrink.cn"
  115. " stem.extract.cn"
  116. " stem.os2/makefile.os2n"
  117. " stem.os2/os2.cn"
  118. " stem.os2/dll/dll.defn"
  119. " stem.os2/dll/unzipapi.cnn"
  120. " rc = UZUnZipToStem('unzip.zip', 'stem.',,,'TREE')n"
  121. " Returns: stem.0 = 4n"
  122. " stem.1 = unzip.cn"
  123. " stem.2 = unshrink.cn"
  124. " stem.3 = extract.cn"
  125. " stem.4 = OS2/n"
  126. " stem.OS2.0 = 3n"
  127. " stem.OS2.1 = makefile.os2n"
  128. " stem.OS2.2 = os2.cn"
  129. " stem.OS2.3 = DLL/n"
  130. " stem.OS2.DLL.0 = 2n"
  131. " stem.OS2.DLL.1 = defn"
  132. " stem.OS2.DLL.2 = unzipapi.cn"
  133. "n"
  134. " And the following contain the contents of then"
  135. " various programs:n"
  136. " stem.unzip.cn"
  137. " stem.unshrink.cn"
  138. " stem.extract.cn"
  139. " stem.OS2.makefile.os2n"
  140. " stem.OS2.os2.cn"
  141. " stem.OS2.DLL.dll.defn"
  142. " stem.OS2.DLL.unzipapi.cn" },
  143.   { "UZVER"        , "UZVer"        ,
  144.                "rc = UZVer([option])nn"
  145. " rc String containing UnZip version info in the form 'x.xx'n"
  146. " If option is 'L' then info is in the form 'x.xx of <date>",
  147.                "Returns the version number of UnZipn" },
  148.   { "UZAPIVER"     , "UZAPIVer"     ,
  149.                "rc = UZAPIVer([option])nn"
  150. " rc String containing API version info in the form 'x.xx'n"
  151. " If option is 'L' then info is in the form 'x.xx of <date>",
  152.                "Returns the version number of the APIn" },
  153.   { 0 }
  154. };
  155. char *REXXBrief = "
  156. REXX functions:n
  157.   UZDropFuncs     -- Makes all functions in this package unknown to REXXn
  158.   UZLoadFuncs     -- Makes all functions in this package known to REXXn
  159.   UZFileTree      -- Searches for files matching a given filespecn
  160.   UZUnZip   -- UnZip command-line entry pointn
  161.   UZUnZipToVar    -- Unzip one file to a variablen
  162.   UZUnZipToStem   -- Unzip files to a variable arrayn
  163.   UZVer           -- Returns the UnZip version numbern
  164.   UZAPIVer        -- Returns the API version numbern";
  165. #endif /* API_DOC && OS2DLL */