home *** CD-ROM | disk | FTP | other *** search
/ NeXTSTEP 3.3 (Developer) / NeXT_Developer-3.3.iso / usr / sybase / doc / dbisopt.man < prev    next >
Encoding:
Text File  |  1993-04-22  |  3.1 KB  |  89 lines
  1.  
  2.   1                       Version 4.0 -- 5/1/89                  dbisopt
  3.   ______________________________________________________________________
  4.  
  5.   NAME:  dbisopt
  6.  
  7.   FUNCTION:
  8.        Check the status of a SQL Server or DB-Library option.
  9.  
  10.   SYNTAX:
  11.        DBBOOL dbisopt(dbproc, option, param)
  12.  
  13.        DBPROCESS *dbproc;
  14.        int       option;
  15.        char      *param;
  16.  
  17.  
  18.  
  19.  
  20.  
  21.  
  22.  
  23.  
  24.   dbisopt                 Version 4.0 -- 5/1/89                        2
  25.   ______________________________________________________________________
  26.  
  27.   COMMENTS:
  28.  
  29.        o This routine checks the status  of  SQL Server  and  DB-Library
  30.          options.   Although  SQL Server  options may be set and cleared
  31.          directly  through  SQL,  the  application  should  instead  use
  32.          dbsetopt()  and dbclropt() to set and clear options.  This pro-
  33.          vides a uniform  interface  for  setting  both  SQL Server  and
  34.          DB-Library  options.  It also allows the application to use the
  35.          dbisopt() function to check the status of an option.
  36.        o For a list of each option  and  its  default  status,  see  the
  37.          manual page for options.
  38.  
  39.   PARAMETERS:
  40.        dbproc -  A pointer to the DBPROCESS structure that provides  the
  41.            connection for a particular front-end/SQL Server process.  It
  42.            contains all the information that DB-Library uses  to  manage
  43.  
  44.  
  45.  
  46.   3                       Version 4.0 -- 5/1/89                  dbisopt
  47.   ______________________________________________________________________
  48.            communications and data between the front end and SQL Server.
  49.            Unlike the functions dbsetopt() and dbclropt(), dbproc cannot
  50.            be NULL here.
  51.        option -  The option to be checked.  See the options manual  page
  52.            for the list of options.
  53.        param -  Certain options take parameters.  The  DBOFFSET  option,
  54.            for example, takes as a parameter the SQL construct for which
  55.            offsets are to be returned.  The options  manual  page  lists
  56.            those  options  that  take parameters.  If an option does not
  57.            take a parameter, param must be NULL.
  58.  
  59.            If the option you are checking takes a  parameter  but  there
  60.            can be only one instance of the option, dbisopt() ignores the
  61.            param argument.  For example, dbisopt() ignores the value  of
  62.            param  when checking the DBBUFFER option, because row buffer-
  63.            ing can have only one setting at a time.  On the other  hand,
  64.            the  DBOFFSET  option  can have several settings, each with a
  65.  
  66.  
  67.  
  68.   dbisopt                 Version 4.0 -- 5/1/89                        4
  69.   ______________________________________________________________________
  70.            different parameter.  It may have been set twice-to look  for
  71.            offsets to SELECT statements and offsets to ORDER BY clauses.
  72.            In that case, dbisopt() needs the param argument to determine
  73.            whether  to  check  the SELECT offset or the ORDER BY offset.
  74.            The only other option for which dbisopt() requires a param is
  75.            DBSTAT.
  76.  
  77.   RETURNS:
  78.        TRUE or FALSE.
  79.  
  80.   SEE ALSO:
  81.        dbclropt, dbsetopt, options
  82.  
  83.  
  84.  
  85.  
  86.  
  87.  
  88.  
  89.