home *** CD-ROM | disk | FTP | other *** search
/ NeXTSTEP 3.3 (Developer) / NeXT_Developer-3.3.iso / usr / sybase / doc / dbtabname.man < prev    next >
Encoding:
Text File  |  1993-04-22  |  2.4 KB  |  67 lines
  1.  
  2.   1                       Version 4.0 -- 5/1/89                dbtabname
  3.   ______________________________________________________________________
  4.  
  5.   NAME:  dbtabname
  6.  
  7.   FUNCTION:
  8.        Return the name of a table based on its number.
  9.  
  10.   SYNTAX:
  11.        char *dbtabname(dbproc, tabnum)
  12.  
  13.        DBPROCESS *dbproc;
  14.        int       tabnum;
  15.  
  16.   COMMENTS:
  17.  
  18.  
  19.  
  20.  
  21.  
  22.  
  23.  
  24.   dbtabname               Version 4.0 -- 5/1/89                        2
  25.   ______________________________________________________________________
  26.  
  27.        o dbtabname() is one of the DB-Library browse mode routines.   It
  28.          is  usable only with results from a browse-mode SELECT (i.e., a
  29.          SELECT containing the key words FOR BROWSE).  See the Introduc-
  30.          tion for a detailed discussion of browse mode.
  31.        o A SELECT query can generate a set of result rows whose  columns
  32.          are derived from several database tables.  dbtabname() provides
  33.          a way for an application to determine the name  of  each  table
  34.          involved  in  an ad hoc query.  If the query has been hardcoded
  35.          into the program, this routine is obviously unnecessary.
  36.  
  37.        o The  application  can   call   dbtabname()   any   time   after
  38.          dbresults().
  39.        o Example 7 in the DB-Library  Reference  Supplement  contains  a
  40.          call to dbtabname().
  41.  
  42.   PARAMETERS:
  43.  
  44.  
  45.  
  46.   3                       Version 4.0 -- 5/1/89                dbtabname
  47.   ______________________________________________________________________
  48.        dbproc -  A pointer to the DBPROCESS structure that provides  the
  49.            connection for a particular front-end/SQL Server process.  It
  50.            contains all the information that DB-Library uses  to  manage
  51.            communications and data between the front end and SQL Server.
  52.        tabnum -  The number of the table  of  interest.   Table  numbers
  53.            start  with 1.  Use dbtabcount() to find out the total number
  54.            of tables involved in a particular query.
  55.  
  56.   RETURNS:
  57.        A pointer to the null-terminated name  of  the  specified  table.
  58.        This  pointer will be NULL if the table number is out of range or
  59.        if the specified table is  a  SQL Server  work  table.   See  the
  60.        dbtabcount() manual page for a description of work tables.
  61.  
  62.   SEE ALSO:
  63.        dbcolbrowse, dbcolsource, dbqual, dbtabbrowse, dbtabcount, dbtab-
  64.        source, dbtsnewlen, dbtsnewval, dbtsput
  65.  
  66.  
  67.