home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 35 Internet / 35-Internet.zip / srev13h.zip / UNZIPAPI.DOC < prev    next >
Text File  |  2000-03-12  |  8KB  |  190 lines

  1. 15 Apr 1998 (updated 11 March 2000)
  2.  
  3. This contains an error-ridden description of UNZIPAPI.DLL.
  4. I've found that in some places where a "stem" variable is
  5. claimed to be needed, you have to use a string instead.
  6. And unziptovar chokes when a file name contains a &.
  7.  
  8. By the way, the sites for the INFO-Zip project (from
  9. whence this hailed) are:
  10.   http://www.cdrom.com/pub/infozip/     (functioning as of 11 March 2000)
  11.   ftp://ftp.uu.net/pub/archiving/zip/ (this may no longer work)
  12.  
  13. Hint: You might want to consider using the rxGzLIB
  14.       procedures (http://www.srehttp.org/apps/rxgzlib)
  15.       instead.
  16.  
  17. -------------------------------------------------------
  18.  
  19. ZDropFuncs
  20.   Use this function to drop all the loaded UnZip functions.
  21.   Once this function is processed by a REXX program, the 
  22.   UnZip functions are not accessible in any OS/2 sessions.  
  23.   
  24. UZLOADFUNCS  
  25.    call UZLoadFuncs
  26.  
  27.                Use this function to make all of the UnZip functions
  28.                in this package available to all OS/2 sessions.
  29.           Example:    call RxFuncAdd 'UZLoadFuncs', 'UNZIPAPI', 'UZLoadFuncs' 
  30.   
  31. UZFILETREE   
  32.    rc = UZFileTree(zipfile, stem, [include], [exclude], [options])  
  33.  
  34.         zipfile    - Name of ZIP file to search 
  35.         stem    - Name of the stem variable for results 
  36.                   Note: stem.0 contains the number of files found.
  37.         include - Optional stem variable specifying a list of files (including 
  38.                   wildcards) to include.  stem.0 must indicate number of items. 
  39.                   exclude - Optional stem variable specifying a list of files 
  40.                   (including  wildcards) to exclude.  
  41.                   stem.0 must indicate number of items.
  42.                NOTE: If lists are not needed, filespec strings may be passed.
  43.         options - One of the following:
  44.                    'O' - Give file names only.  This is the default. 
  45.                    'F' - Give file statistics in the form: 
  46.                               "Length Date Time Name 
  47.                    'Z' - Also give ZIP statistics in the form: 
  48.                             "Length Method Size Ratio Date Time CRC-32 Name
  49.  
  50.      Finds all files in the specified ZIP with the specified
  51.         filespec and places their descriptions in a stem variable.  
  52.         rc:    Return codes 
  53.                 0    Successful 
  54.                 2    Error.  Not enough memory.  
  55.         Examples: 
  56.                 /*Return a list of all .NDX files in pcboard.qwk*/
  57.                  rc = UZFileTree('pcboard.qwk', 'stem.', '*.ndx')
  58.                 /* Return a list of all files except *.NDX and *.DAT */
  59.                 exc.0 = 2; exc.1 = '*.ndx'; exc.2 = '*.dat' 
  60.                 rc = UZFileTree('pcboard.qwk', 'stem.',,'exc.')  
  61.   
  62. UZUNZIP
  63.        rc = UZUnZip('parameters', [stem])  
  64.  
  65.                 parameters    - The entire list of parameters you would use from 
  66.                                   the command-line 
  67.                 stem        - The name of an optional stem variable where any 
  68.                                   output should be redirected. 
  69.                           NOTE: If a stem is not specified, all output will 
  70.                                 go to the console.
  71.  Provide a direct entry point to the command line interface.  
  72.     rc:    UnZip return code  
  73.     Examples:    /* Test the archive 'unzip51s.zip' and return output in stem.*/
  74.                 rc = UZUnZip('-t unzip51s.zip','stem.')
  75.                /* Extract the archive, display output on screen */
  76.                call UZUnZip 'doom.zip' 
  77.                         /* Extract all .NDX files from the archive  */
  78.                         call UZUnZip 'pcboard.qwk *.ndx','stem.'  
  79.   
  80. UZUNZIPTOVAR 
  81.  
  82.      rc = UZUnZipToVar('zipfile', 'filename', [stem])  
  83.                 zipfile     - Name of ZIP file to search 
  84.                 filename - Name of file to extract from zipfile 
  85.                 stem     - Optional stem variable to extract the file to. 
  86.                            If you specify a stem variable, the file will be 
  87.                            extracted to the variable, one line per index, 
  88.                            stem.0 containing a line count.  
  89.                            In this case, 0 will be returned in rc.
  90.                            If NO stem variable is specified, the entire file   
  91.                            will be extracted to rc.
  92.            Unzip one file to a variable.  
  93.     rc:    If no stem variable is specified, rc contains the contents of 
  94.         the extracted file if successful or an error-code if not. 
  95.         If a stem variable IS specified, rc contains 0 if successful. 
  96.   
  97. UZUNZIPTOSTEM
  98.  
  99.   rc = UZUnZipToStem(zipfile, stem, [include], [exclude], [mode]) 
  100.  
  101.     zipfile  - Name of ZIP file to search
  102.     stem    - Stem variable used to store the extracted files 
  103.     include - Optional stem variable specifying a list of files (including 
  104.           wildcards) to include.  stem.0 must indicate number of items. 
  105.     exclude - Optional stem variable specifying a list of files (including 
  106.           wildcards) to exclude.  stem.0 must indicate number of items. 
  107.         NOTE: If lists are not needed, filespec strings may be passed. 
  108.     mode    - Optional mode parameter specifies either 'F'lat (the default) 
  109.           or 'T'ree mode. 
  110.         -- In flat mode, each file is stored in stem.fullname i.e. 
  111.            stem.os2/dll/unzipapi.c.  A list of files is created in 
  112.            stem.<index> 
  113.         -- In tree mode, slashes are converted to periods in the 
  114.            pathname thus the above file would have been stored in 
  115.            stem.OS2.DLL.unzipapi.c and an index stored for each 
  116.            directory, i.e. stem.OS2.DLL.<index> = \"unzipapi.c\", 
  117.            stem.OS2.<index> = \"DLL/\", stem.<index> = \"OS2/\"",
  118.            "Unzip files to a stem variable.  
  119.     Example:    Assuming a file unzip.zip containing: 
  120.               unzip.c, unshrink.c, extract.c, 
  121.               os2/makefile.os2, os2/os2.c 
  122.               os2/dll/dll.def, os2/dll/unzipapi.c  
  123.         rc = UZUnZipToStem('unzip.zip', 'stem.') 
  124.         Returns:    stem.0 = 7 
  125.                 stem.1 = unzip.c 
  126.                 stem.2 = unshrink.c 
  127.                 stem.3 = extract.c 
  128.                 stem.4 = os2/makefile.os2 
  129.                 stem.5 = os2/os2.c 
  130.                 stem.6 = os2/dll/dll.def 
  131.                 stem.7 = os2/dll/unzipapi.c 
  132.             And the following contain the contents of the 
  133.             various files: 
  134.                 stem.unzip.c 
  135.                 stem.unshrink.c 
  136.                 stem.extract.c 
  137.                 stem.os2/makefile.os2 
  138.                 stem.os2/os2.c 
  139.                 stem.os2/dll/dll.def 
  140.                 stem.os2/dll/unzipapi.c  
  141.         rc = UZUnZipToStem('unzip.zip', 'stem.',,,'TREE') 
  142.         Returns:    stem.0 = 4 
  143.             stem.1 = unzip.c 
  144.             stem.2 = unshrink.c 
  145.             stem.3 = extract.c 
  146.             stem.4 = OS2/ 
  147.             stem.OS2.0 = 3 
  148.             stem.OS2.1 = makefile.os2 
  149.             stem.OS2.2 = os2.c 
  150.             stem.OS2.3 = DLL/ 
  151.             stem.OS2.DLL.0 = 2 
  152.             stem.OS2.DLL.1 = def 
  153.             stem.OS2.DLL.2 = unzipapi.c 
  154.  
  155.         And the following contain the contents of the 
  156.         various programs: 
  157.             stem.unzip.c 
  158.             stem.unshrink.c 
  159.             stem.extract.c 
  160.             stem.OS2.makefile.os2 
  161.             stem.OS2.os2.c 
  162.             stem.OS2.DLL.dll.def 
  163.             stem.OS2.DLL.unzipapi.c  },
  164.  
  165. UZVer  
  166.     rc = UZVer([option])  
  167.         rc    String containing UnZip version info in the form 'x.xx'
  168.             If option is 'L' then info is in the form 'x.xx of <date>
  169.     Returns the version number of UnZip  
  170.  
  171. UZAPIVER  
  172.       rc = UZAPIVer([option])  
  173.         rcString containing API version info in the form 'x.xx' 
  174.                 If option is 'L' then info is in the form 'x.xx of <date>
  175.         Returns the version number of the API  
  176.  
  177.  
  178. REXX functions:
  179.   UZDropFuncs     -- Makes all functions in this package unknown to REXX 
  180.   UZLoadFuncs     -- Makes all functions in this package known to REXX 
  181.   UZFileTree      -- Searches for files matching a given filespec 
  182.   UZUnZip      -- UnZip command-line entry point 
  183.   UZUnZipToVar    -- Unzip one file to a variable 
  184.   UZUnZipToStem   -- Unzip files to a variable array 
  185.   UZVer           -- Returns the UnZip version number 
  186.   UZAPIVer        -- Returns the API version number 
  187.  
  188.  
  189.  
  190.