home *** CD-ROM | disk | FTP | other *** search
/ NeXTSTEP 3.3 (Developer) / NeXT_Developer-3.3.iso / usr / sybase / doc / dbreadpage.man < prev    next >
Encoding:
Text File  |  1993-04-22  |  2.3 KB  |  89 lines
  1.  
  2.   1                       Version 4.0 -- 5/1/89               dbreadpage
  3.   ______________________________________________________________________
  4.  
  5.   NAME:  dbreadpage
  6.  
  7.   FUNCTION:
  8.        Read a page of binary data from SQL Server.
  9.  
  10.   SYNTAX:
  11.        DBINT dbreadpage(dbproc, dbname, pageno, buf)
  12.  
  13.        DBPROCESS *dbproc;
  14.        char      *dbname;
  15.        DBINT     pageno;
  16.        BYTE      buf[];
  17.  
  18.  
  19.  
  20.  
  21.  
  22.  
  23.  
  24.   dbreadpage              Version 4.0 -- 5/1/89                        2
  25.   ______________________________________________________________________
  26.  
  27.   COMMENTS:
  28.  
  29.        o dbreadpage() reads a page of binary data from SQL Server.  This
  30.          routine is primarily useful for examining and repairing damaged
  31.          database pages.  After calling dbreadpage(), the DBPROCESS  may
  32.          contain  some  error or informational messages from SQL Server.
  33.          These messages may be accessed through a user-supplied  message
  34.          handler.
  35.  
  36.  
  37.          WARNING  ________________________________________________________
  38.          ||  Use this routine only if you are absolutely sure you know    |
  39.          |  what you are doing!                                          |
  40.          |_______________________________________________________________||
  41.  
  42.  
  43.  
  44.  
  45.  
  46.   3                       Version 4.0 -- 5/1/89               dbreadpage
  47.   ______________________________________________________________________
  48.   PARAMETERS:
  49.        dbproc -  A pointer to the DBPROCESS structure that provides  the
  50.            connection for a particular front-end/SQL Server process.  It
  51.            contains all the information that DB-Library uses  to  manage
  52.            communications and data between the front end and SQL Server.
  53.        dbname -  The name of the database of interest.
  54.        pageno -  The number of the database page to be read.
  55.        buf -  A pointer to a buffer to  hold  the  received  page  data.
  56.            SQL Server pages are currently 2048 bytes long.
  57.  
  58.   RETURNS:
  59.        The number of bytes read from SQL Server. If  the  operation  was
  60.        unsuccessful, dbreadpage returns -1.
  61.  
  62.   LIMITATIONS:
  63.        Alters the contents of the DBPROCESS command buffer.
  64.  
  65.  
  66.  
  67.  
  68.   dbreadpage              Version 4.0 -- 5/1/89                        4
  69.   ______________________________________________________________________
  70.  
  71.   SEE ALSO:
  72.        dbmsghandle, dbwritepage
  73.  
  74.  
  75.  
  76.  
  77.  
  78.  
  79.  
  80.  
  81.  
  82.  
  83.  
  84.  
  85.  
  86.  
  87.  
  88.  
  89.