home *** CD-ROM | disk | FTP | other *** search
/ NeXTSTEP 3.3 (Developer) / NeXT_Developer-3.3.iso / usr / sybase / doc / dbclropt.man < prev    next >
Encoding:
Text File  |  1993-04-22  |  4.0 KB  |  111 lines
  1.  
  2.   1                       Version 4.0 -- 5/1/89                 dbclropt
  3.   ______________________________________________________________________
  4.  
  5.   NAME:  dbclropt
  6.  
  7.   FUNCTION:
  8.        Clear an option set by dbsetopt().
  9.  
  10.   SYNTAX:
  11.        RETCODE dbclropt(dbproc, option, param)
  12.  
  13.        DBPROCESS *dbproc;
  14.        int       option;
  15.        char      *param;
  16.  
  17.  
  18.  
  19.  
  20.  
  21.  
  22.  
  23.  
  24.   dbclropt                Version 4.0 -- 5/1/89                        2
  25.   ______________________________________________________________________
  26.  
  27.   COMMENTS:
  28.  
  29.        o This routine clears SQL Server and DB-Library options that have
  30.          been  set  with dbsetopt().  Although SQL Server options may be
  31.          set and cleared directly through SQL,  the  application  should
  32.          instead use dbsetopt() and dbclropt() to set and clear options.
  33.          This provides a uniform interface for setting  both  SQL Server
  34.          and  DB-Library options.  It also allows the application to use
  35.          the dbisopt() function to check the status of an option.
  36.        o dbclropt() does not immediately clear the option.   The  option
  37.          is  cleared  the  next  time  a  command  buffer is sent to the
  38.          SQL Server (by invoking dbsqlexec() or dbsqlsend()).
  39.  
  40.        o For a complete  list  of  options,  see  the  manual  page  for
  41.          options.
  42.  
  43.  
  44.  
  45.  
  46.   3                       Version 4.0 -- 5/1/89                 dbclropt
  47.   ______________________________________________________________________
  48.  
  49.   PARAMETERS:
  50.        dbproc -  A pointer to the DBPROCESS structure that provides  the
  51.            connection for a particular front end/SQL Server process.  It
  52.            contains all the information that DB-Library uses  to  manage
  53.            communications and data between the front end and SQL Server.
  54.            If dbproc is NULL, the option will be cleared for all  active
  55.            DBPROCESS structures.
  56.        option -  The option that is to be turned off.  See  the  options
  57.            manual page for the list of options.
  58.        param -  Certain options take parameters.  The  DBOFFSET  option,
  59.            for example, takes as a parameter the SQL construct for which
  60.            offsets are to be returned.  The options  manual  page  lists
  61.            those  options  that  take parameters.  If an option does not
  62.            take a parameter, param must be NULL.
  63.  
  64.            If the option you are clearing takes a  parameter  but  there
  65.            can  be  only  one instance of the option, dbclropt() ignores
  66.  
  67.  
  68.   dbclropt                Version 4.0 -- 5/1/89                        4
  69.   ______________________________________________________________________
  70.            the param argument.   For  example,  dbclropt()  ignores  the
  71.            value of param when clearing the DBBUFFER option, because row
  72.            buffering can have only one setting at a time.  On the  other
  73.            hand,  the  DBOFFSET  option  can have several settings, each
  74.            with a different parameter.  It may have  been  set  twice-to
  75.            look for offsets to SELECT statements and offsets to ORDER BY
  76.            clauses.  In that case, dbclropt() needs the  param  argument
  77.            to  determine whether to clear the SELECT offset or the ORDER
  78.            BY offset.   The  only  other  option  for  which  dbclropt()
  79.            requires a param is DBSTAT.
  80.  
  81.            If  an  invalid  parameter  is  specified  for  one  of   the
  82.            SQL Server  options,  this will be discovered the next time a
  83.            command buffer is sent to the SQL Server.  The dbsqlexec() or
  84.            dbsqlsend()  call  will  fail, and DB-Library will invoke the
  85.            user-installed message handler.  If an invalid  parameter  is
  86.            specified  for  one  of  the  DB-Library options (DBBUFFER or
  87.            DBTEXTLIMIT), the dbclropt() call itself will fail.
  88.  
  89.  
  90.   5                       Version 4.0 -- 5/1/89                 dbclropt
  91.   ______________________________________________________________________
  92.  
  93.   RETURNS:
  94.        SUCCEED or FAIL.
  95.  
  96.   SEE ALSO:
  97.        dbisopt, dbsetopt, options
  98.  
  99.  
  100.  
  101.  
  102.  
  103.  
  104.  
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.