home *** CD-ROM | disk | FTP | other *** search
/ PC World 1999 May / PCWorld_1999-05_cd.bin / software / Vyzkuste / inprise / INTRBASE_55 / EXAMPLES / API / README < prev    next >
Text File  |  1998-10-18  |  4KB  |  128 lines
  1. The following example programs demonstrate a number of useful features of
  2. the InterBase programming interface.  Only the api<n>.c programs are 
  3. available on Windows 3.1 clients (except api9f.c and api16.c).  
  4. All others are available on all platforms.
  5.  
  6. Note that the following environment variables need to be set before running
  7. the examples (before loading Windows for the InterBase Client for Windows):
  8.  
  9. ISC_USER     - A valid username on the server.
  10. ISC_PASSWORD - The password for the above user.
  11. ISC_DATABASE - The path to the employee.gdb example database, including
  12.            server name.  For example, to connect to the NT server
  13.            named "NTserver" via NetBEUI:
  14.         ISC_DATABASE=\\NTserver\c:\ibserver\examples
  15.            
  16.            This assumes that InterBase was installed to the
  17.            default directory on the server, c:\ibserver.
  18.  
  19. In addition, a guest account should be created with the username "guest"
  20. and password "guest" before running api15 and winevent.
  21.  
  22. Embedded Static SQL
  23.  
  24. Program     Description
  25. ---------   ------------------------------------------------------------------
  26. stat1.e     Illustrates a simple update to an existing table, commit, rollback.
  27.  
  28. stat2.e     Illustrates singleton select.
  29.  
  30. stat3.e     Illustrates a simple cursor -- declare/open/close/fetch.
  31.  
  32. stat4.e     Show 'declare table' and 'create table'.
  33.  
  34. stat5.e     Demonstrate 'update where current of'.
  35.  
  36. stat6.e     Select an array.
  37.  
  38. stat7.e     Illustrate blob cursor for select.
  39.  
  40. stat8.e     Illustrate blob cursor for insert.
  41.  
  42. stat9.e     Execute and select from a stored procedure.
  43.  
  44. stat10.e    Demonstrate 'set database', 'connect' and 'set transaction'.
  45.  
  46. stat11.e    Demonstrate 'set transaction' with various isolation options.
  47.  
  48. stat12.e    Event wait and signaling.
  49. stat12t.e
  50.  
  51. WHENEVER SQLERROR and BASED_ON clause are illustrated by many programs.
  52. ^L
  53.  
  54. Embedded Dynamic SQL
  55.  
  56. Program     Description
  57. ---------   ------------------------------------------------------------------
  58. dyn1.e      Execute 'create database' statement as a static string.
  59.  
  60. dyn2.e      'Execute immediate', and 'prepare' and 'execute'.
  61.  
  62. dyn3.e      Dynamic cursor for select with output SQLDA allocated.
  63.  
  64. dyn4.e      Execute an update query with parameter markers and input SQLDA.
  65.  
  66. dyn5.e      Demonstrate dynamic reallocation of SQLDA and 'describe' statement.
  67.  
  68. dynfull.e   A full_dsql program (process unknown statements).
  69.  
  70. VARY struct is used by dyn3.e, dynfull.e.
  71. ^L
  72.  
  73. API Interface
  74.  
  75. Program     Description
  76. ---------   ------------------------------------------------------------------
  77. api1.c      Execute 'create dabatabase' statement as a static string.
  78.             Demonstrates zero database handle.
  79.  
  80. api2.c      'Execute immediate', and 'prepare' and 'execute'.
  81.  
  82. api3.c      Dynamic cursor for select with output SQLDA allocated.
  83.  
  84. api4.c      Execute an update query with parameter markers and input SQLDA.
  85.  
  86. api5.c      Demonstrate dynamic reallocation of SQLDA and 'describe' statement.
  87.  
  88. apifull.c   A full_dsql program (process unknown statements).
  89.         Demonstrates stmt_info calls and numeric scale.
  90.  
  91. api6.c      Assemble an update current of statement, based on a dynamic
  92.             cursor name.  Free a statement handle and re-use it as the cursor.
  93.  
  94. api7.c      Demonstrate blob_open, get_segment.
  95.  
  96. api8.c      Demonstrate create_blob, put_segment.
  97.  
  98. api9.c      Demonstrate blob_open2 (using blob filter).
  99. api9f.c     Filter for api9.c.  (Not part of Windows 3.1 clients)
  100.  
  101. api10.c     Update an array using get_slice/put_slice.
  102.  
  103. api11.c     Execute and select from a stored procedure.
  104.  
  105. api12.c     A program with several active transactions.
  106.  
  107. api13.c     A multi-database transaction with 2-phase commit.
  108.  
  109. api14.e     Combine the three programming styles in one program.
  110.  
  111. api15.c        Construct a database parameter buffer.  db_info calls.
  112.  
  113. api16.c        Demonstrate asynchronous event trapping
  114.             (Not available on Windows 3.1 clients)
  115.  
  116. winevent.c  Demonstrate asynchronous event trapping
  117.             (Replacement for api16.c on Windows 3.1 Client)
  118.  
  119. api16t.c    Identical to stat12t, this triggers the event for api16.
  120.  
  121. VARY struct is used by api3.c, apifull.c, and api14.e.
  122.  
  123. SQLCODE extraction from status is covered by several programs.
  124.  
  125. Zero transaction handle is covered in several programs, ex. api14.e.
  126.  
  127.  
  128.