home *** CD-ROM | disk | FTP | other *** search
/ NeXTSTEP 3.3 (Developer) / NeXT_Developer-3.3.iso / usr / sybase / doc / dbgetuserdata.man < prev    next >
Encoding:
Text File  |  1993-04-22  |  1.9 KB  |  67 lines
  1.  
  2.   1                       Version 4.0 -- 5/1/89            dbgetuserdata
  3.   ______________________________________________________________________
  4.  
  5.   NAME:  dbgetuserdata
  6.  
  7.   FUNCTION:
  8.        Return a pointer to user-allocated data from a  DBPROCESS  struc-
  9.        ture.
  10.  
  11.   SYNTAX:
  12.        BYTE *dbgetuserdata(dbproc)
  13.  
  14.        DBPROCESS *dbproc;
  15.  
  16.   COMMENTS:
  17.  
  18.  
  19.  
  20.  
  21.  
  22.  
  23.  
  24.   dbgetuserdata           Version 4.0 -- 5/1/89                        2
  25.   ______________________________________________________________________
  26.  
  27.        o This routine returns, from a DBPROCESS structure, a pointer  to
  28.          user-allocated  data.   The  application  must  have previously
  29.          saved this pointer with the dbsetuserdata() routine.
  30.        o dbgetuserdata() and dbsetuserdata() allow  the  application  to
  31.          associate  user  data with a particular DBPROCESS.  This avoids
  32.          the necessity of using global variables for this purpose.   One
  33.          use  for  these routines is to handle deadlock, as shown in the
  34.          example on  the  dbsetuserdata()  manual  page.   That  example
  35.          reruns  the  transaction when the application's message handler
  36.          detects deadlock.
  37.  
  38.        o This routine is particularly useful when  the  application  has
  39.          multiple DBPROCESSes.
  40.  
  41.   PARAMETERS:
  42.        dbproc -  A pointer to the DBPROCESS structure that provides  the
  43.            connection for a particular front-end/SQL Server process.  It
  44.  
  45.  
  46.   3                       Version 4.0 -- 5/1/89            dbgetuserdata
  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.        A generic BYTE pointer to the user's private  data  space.   This
  53.        pointer  must have been previously saved with the dbsetuserdata()
  54.        routine.
  55.  
  56.   SEE ALSO:
  57.        dbsetuserdata
  58.  
  59.  
  60.  
  61.  
  62.  
  63.  
  64.  
  65.  
  66.  
  67.