5 May 1999.  christopher.mcrae@mq.edu.au

The RxSWISH dynamic link library for OS/2.

This is an early release of the RxSwish dynamic link library (DLL).
One procedure is supported: rxswEMULATE -- which will emulate
execution SWISH.  Later versions will contain a richer set of 
procedures that programers can use for specific purposes (such as
finding matches, adding to an index, etc.).



I)RxSWISH Emulation Mode:

This simply emulates execution of SWISH from a command line; with exactly
the same switches.  The only difference is that output is returned (if
desired) to the calling program. Only one procedure is used, rxswEMULATE.

rxswEMULATE  : Emulate command line execution of SWISH

  Syntax:
      status=rxswEMULATE(swish_command_string,[output_mode, stem or
                                                            filename])
  where:
    swish_command_string : 
         a command string that one would use when executing SWISH from an
         OS/2 command prompt.  For example:
            ' -c index1.con '                 
            ' -i index.swish -w oxygen nitrogen'                     
    output_Mode (optional)
         If specified, output_mode specifies where output should be
         directed to. Allowed options are:
                0) Discard all output (this is the default)
                1) Return output to the caller in a stem variable,
                   specified as the next argument. Stem.0 contains the
                   number of lines returned
                2) Write output to the file specified as the next
                   argument.

     status:  Status code. Valid status codes are:
                 0 = Success
                11 = Error creating Stem variable.
                21 = Bad filename for Dump file.
               100 = Unknown -S option.
               101 = No configuration file specified.
               102 = Specify Tag fields (HBtheca).
               103 = Specify the index file to decode.
               104 = Couldn't open index file.
               105 = index file has an unknown format.
               106 - Specify directories or files to index.
               107 - Couldn't write the index file.
               108 - Specify index files and an output file.
               109 - The index file(s) is empty.
               200 - All search words too common to be useful.
               202 - No search words specified.
               204 - The supplied metaName doesn't exist in  user
                     configfile.

  Example:
       status=rxswEMULATE('-c myconfig.con ','1','Output')
       status=rxswEMULATE('-c myconfig.con ','2','Output.txt')
       status=rxswEMULATE('-f myindex.swi -w foo and bar')



