home *** CD-ROM | disk | FTP | other *** search
/ NeXTSTEP 3.3 (Developer) / NeXT_Developer-3.3.iso / usr / sybase / doc / dbcanquery.man < prev    next >
Encoding:
Text File  |  1993-04-22  |  2.0 KB  |  67 lines
  1.  
  2.   1                       Version 4.0 -- 5/1/89               dbcanquery
  3.   ______________________________________________________________________
  4.  
  5.   NAME:  dbcanquery
  6.  
  7.   FUNCTION:
  8.        Cancel any rows pending from the most recently executed query.
  9.  
  10.   SYNTAX:
  11.        RETCODE dbcanquery(dbproc)
  12.  
  13.        DBPROCESS *dbproc;
  14.  
  15.   COMMENTS:
  16.  
  17.        o This routine is an efficient way to throw away any unread  rows
  18.  
  19.  
  20.  
  21.  
  22.  
  23.  
  24.   dbcanquery              Version 4.0 -- 5/1/89                        2
  25.   ______________________________________________________________________
  26.          that result from the most recently executed SQL query.  Calling
  27.          dbcanquery()  is  equivalent  to  calling  dbnextrow() until it
  28.          returns NO_MORE_ROWS, but dbcanquery()  is  faster  because  it
  29.          allocates no memory and executes no bindings to user data.
  30.  
  31.        o If you have set your own interrupt  handler  using  dbsetinter-
  32.          rupt(),  you can't call dbcanquery() in your interrupt handler.
  33.          This would cause output from SQL Server to DB-Library to become
  34.          out  of  sync.   If you want to ignore any unread rows from the
  35.          current query, the interrupt handler should set a flag that you
  36.          can check before the next call to dbnextrow().
  37.        o If you want to ignore all of the results from all of  the  com-
  38.          mands in the current command batch, call dbcancel() instead.
  39.  
  40.   PARAMETERS:
  41.        dbproc -  A pointer to the DBPROCESS structure that provides  the
  42.            connection for a particular front-end/SQL Server process.  It
  43.  
  44.  
  45.  
  46.   3                       Version 4.0 -- 5/1/89               dbcanquery
  47.   ______________________________________________________________________
  48.            contains all the information that DB-Library uses  to  manage
  49.            communications and data between the front end and SQL Server.
  50.  
  51.   RETURNS:
  52.        SUCCEED or FAIL.  The most common reasons for failure are a  dead
  53.        DBPROCESS or a network error.
  54.  
  55.   SEE ALSO:
  56.        dbcancel, dbnextrow, dbresults, dbsetinterrupt, dbsqlexec
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.  
  64.  
  65.  
  66.  
  67.