home *** CD-ROM | disk | FTP | other *** search
/ C Programming Starter Kit 2.0 / SamsPublishing-CProgrammingStarterKit-v2.0-Win31.iso / bde / snipit.pak / SNIPIT.TXT < prev    next >
Text File  |  1997-07-23  |  11KB  |  240 lines
  1.                        SNIPIT Code Viewer Documentation
  2.                        --------------------------------
  3.  
  4. Contents
  5. --------
  6. I.     List of shipped files
  7. II.    Prerequisites
  8. III.   Using SNIPIT Code Viewer
  9.  
  10.  
  11. I. List of shipped files
  12. ------------------------
  13.  
  14. aliases.c   Displays the aliases available in the current configuration
  15.             file.
  16. batmove.c   Shows how to use the DbiBatchMove function
  17. blobio.c    Shows how to use BLOBs
  18. blobsmpl.c  A simple example of using BLOBs
  19. block.c     How to use blockmove to speed up table access
  20. bookmark.c  Saving the current record position using bookmarks
  21. callback.c  Registering a function to be automatically called by IDAPI.
  22. config.c    Dsplaying the information in the configuration file
  23. cr8dbtbl.c  How to create a dBASE table
  24. cr8pxtbl.c  How to create a Paradox table
  25. cr8txtbl.c  How to create a Text table
  26. dbio.c      How to manipulate databases
  27. drvcaps.c   Determining the capabilities of the available drivers
  28. errval.c    Getting the error value and displaying error information
  29. fieldmap.c  Changing the fields which are used in a table
  30. filter.c    Limiting the records accessable from a table using filters
  31. format.c    Getting the date and time format from the configuration file
  32. idxdbase.c  Using dBASE indexes
  33. idxexpr.c   Using dBASE expression indexes
  34. idxpdox.c   Using Paradox indexes
  35. initeng.c   How to initialize IDAPI
  36. inmemtbl.c  How to create an in-memory table
  37. lnkcrsr.c   How to limit the records of one table depending on the current
  38.             record in another table
  39. lsql.c      A simple SQL example on a local table
  40. lsqljoin.c  An SQL join of a dBASE and a Paradox table
  41. lsqllive.c  Showing the use of a live answer table
  42. navigate.c  How to use navigation with IDAPI
  43. optparam.c  Using optional paramaters when creating a table
  44. password.c  Using Passwords with Paradox tables
  45. prdxsort.c  Sorting Paradox tables
  46. qbe.c       A simple Query by Example (QBE) example
  47. qbe2.c      A join of a dBASE and a Paradox table using QBE
  48. range.c     Limiting the records returned from a table to within an upper
  49.             and lower range
  50. rdolock.c   Creating a read-only directory (Paradox only)
  51. reclock.c   Locking Records
  52. recupdat.c  Inserting and modifying records
  53. refinteg.c  Creating Referential Integrity Links
  54. search.c    How to search IDAPI tables
  55. secdesc.c   Using Auxilliary Passords, also called security descriptors.
  56.             (Paradox Only)
  57. session.c   Using multiple sessions with IDAPI
  58. softdel.c   How to set properties and use soft delete (dBASE only)
  59. sqlbind.c   Parameter binding in SQL statements
  60. sysinfo.c   Getting information about the IDAPI system
  61. tblinfo.c   Getting information about a table
  62. tbllist.c   Getting a list of the available tables
  63. tbllock.c   Using table locking
  64. tblopen.c   How to open a table
  65. tbrstrct.c  Restructuring a table
  66. test.c      Basic framework to use for testing or creating new examples
  67. textexp.c   Exporting data from a Paradox table to a Text table
  68. textimp.c   Importing data from a Text table to a dBASE table
  69. transact.c  Using transactions and SQL on remote tables
  70. upsize.c    Copying local tables to a server.
  71. valcheck.c  Shows how to use validity checks (Paradox only)
  72.  
  73. input.c     Used by SNIPIT for keeping track of the examples
  74. snipdata.c  Contains the global data used by SNIPIT
  75. snipmain.c  The main portion of the SNIPIT Code Viewer
  76. sniptool.c  Helper functions used by the examples
  77. snipit.h    Contains prototypes for functions used by the SNIPIT Code
  78.             Viewer
  79. id_defs.h   File contains #defines used in the SNIPIT Code Viewer
  80.  
  81. makefile    Makefile for Borland C++ v4.0 and later
  82. makemsc.mak Makefile for Microsoft C\C++ v1.5
  83. snipit.ide  Project file for BC 4.0
  84. snipit.def  Module Definition file
  85. snipit.rc   Resource file
  86.  
  87. II. Prerequisites
  88. -----------------
  89.  
  90.    The following software must be installed to run SNIPIT Code Viewer:
  91.       -IDAPI Software Development Kit (SDK)
  92.       -Microsoft Windows 3.1 or higher
  93.  
  94.    The following software must be installed to run SNIPIT Code Viewer from
  95.    a debugger:
  96.       -Borland C++ Version 4.02 or higher, or Microsoft C/C++ Version 1.5
  97.       -An online debugger compatible with the installed C/C++ compiler
  98.        (optional)
  99.  
  100.    Note: SNIPIT Code Viewer is shipped pre-compiled with Borland C++
  101.          Version 4.02. If you are using a different compiler, you can
  102.          recompile SNIPIT Code Viewer so that you can run it successfully
  103.          with your compiler's debugger.
  104.  
  105.  
  106. III. Using SNIPIT Code Viewer
  107. -----------------------------
  108.  
  109. Overview
  110. --------
  111.    SNIPIT Code Viewer is part of the IDAPI SDK; it is an online utility
  112.    for viewing and running pre-compiled and linked C code samples that
  113.    demonstrate IDAPI function calls. You can select a code sample from a
  114.    list, display it on screen, and cut and paste selections into your own
  115.    source code. You can run the code sample, and watch as its output
  116.    messages are displayed on screen. You can also run SNIPIT Code Viewer
  117.    with an online debugger, stepping through each line of code as it
  118.    executes.
  119.  
  120. Starting SNIPIT Code Viewer
  121. ---------------------------
  122.    Start the SNIPIT Code Viewer by double-clicking the SNIPIT Code Viewer
  123.    icon in the IDAPI SDK program group. The SNIPIT Code Viewer window is
  124.    displayed full screen. You can adjust the window size, or reduce it to
  125.    an icon.
  126.  
  127. Finding the Appropriate Code Sample
  128. -----------------------------------
  129. 1. Find the Code Sample by scrolling through the Sample Code list box.
  130.    Each code sample is named for the type of IDAPI functionality it
  131.    demonstrates. For example, 'Table: Create Paradox' shows how to create
  132.    and delete a simple Paradox table.
  133.  
  134. 2. Click once to select the code sample. When a code sample is selected,
  135.    the Description list box describes briefly what it does, for example:
  136.  
  137.       Create a Paradox table, insert 10 records, then delete the table.
  138.  
  139.    The name of the file where the code sample resides is displayed below
  140.    the Description list box, for example:
  141.  
  142.       cr8pxtbl.c
  143.  
  144.    All SNIPIT sample code is installed in the SNIPIT directory.
  145.  
  146.  
  147. Viewing Sample Code
  148. -------------------
  149. 1. Double-click the selected code sample or choose the View button (or
  150.    choose View from the File pull-down menu). The selected code sample is
  151.    displayed in the Sample Code Viewer window.
  152.  
  153. 2. Use the scroll bar in the Sample Code Viewer window to scroll through
  154.    the source code.
  155.  
  156.    Each code sample is stand-alone, so there is a fair amount of redundant
  157.    code used to perform routine operations such as initializing the engine
  158.    and closing the database. For simplicity's sake, SNIPIT Code Viewer
  159.    does not display all of this redundant code. You see only the names of
  160.    the internal support functions that perform these routine operations:
  161.       - ChkRslt
  162.             Outputs the supplied string if the actual result does
  163.             not equal the expected result.
  164.       - CloseDbAndExit
  165.             Closes the specified database and exits IDAPI.
  166.       - CreateAndFillTable
  167.             Creates a table and fills it with random data. This function
  168.             uses the internal support function FillTable () to generate
  169.             the data. Examples for all IDAPI field types are included in
  170.             this function.
  171.       - DisplayInMemoryTable
  172.             Dumps a specified number of records to the screen from the
  173.             specified in-memory table (i.e., virtual table).
  174.       - DisplayTable
  175.             Dumps a specified number of records to the screen from the
  176.             specified table.
  177.       - FillTable
  178.             Fills the specified table with random data. This routine can
  179.             generate data for any IDAPI field type.
  180.       - InitAndConnect
  181.             Initializes IDAPI and connects to a standard database
  182.             (i.e., one used by dBASE and Paradox).
  183.       - InitAndConnect2
  184.             Initializes IDAPI and connects to an SQL database. This
  185.             function displays available databases and allows the user
  186.             to select which database is used.
  187.       - MakeFullPath
  188.             Returns the fully qualified path to the IDAPI working
  189.             directory.
  190.       - Screen
  191.             Outputs a supplied string to the edit control.
  192.       - WinMsg
  193.             Pops up a Windows message box. This function is similar to,
  194.             but easier to use than the Windows function MessageBox().
  195.  
  196.  
  197. Cutting and Pasting Sample Code
  198. -------------------------------
  199. 1. Select the code you want to copy from the Sample Code Viewer window,
  200.    and choose the Copy button to copy it to the clipboard (or choose Copy
  201.    text from the Edit Menu). Note that all text in the output edit control
  202.    will be copied if no text is selected.
  203.  
  204. 2. Paste the code from the clipboard into your program's source code.
  205.  
  206.  
  207. Running Sample Code
  208. -------------------
  209. 1. Choose the Run button to execute the selected code sample . Note that
  210.    the Sample Code Viewer window has now become the Sample Code Output
  211.    window; it displays the code sample's output as the code executes. If
  212.    you are running SNIPIT Code Viewer without a debugger, these output
  213.    messages are all you see.
  214.  
  215. 2. To step through the each line of source code as the application
  216.    executes, run SNIPIT Code Viewer from an online debugger, as follows:
  217.  
  218.      a. Start the online debugger, and run snipit.exe. There is no need
  219.         to set a breakpoint; a breakpoint has been pre-set at the
  220.         beginning of each code sample.
  221.  
  222.      Note: The preferred application for running the samples is under the
  223.            Borland C++  Version 4.0 Integrated Development Environment
  224.            (IDE). The suplied IDAPI.TOK file can be used in the IDE to
  225.            do syntax highlighting of the IDAPI functions and types. This
  226.            makes it much easier to see the IDAPI-specific parts of the
  227.            code.
  228.  
  229.      Note: If you cannot run SNIPIT Code Viewer with your debugger, you may
  230.            need to recompile SNIPIT Code Viewer. (It is shipped pre-compiled
  231.            with Borland C++ Version 4.0).
  232.  
  233.      b. When the SNIPIT Code Viewer window is displayed, select the code
  234.         sample you wish to run, and choose the Run button.
  235.  
  236.      c. The online debugger stops execution at the breakpoint at the
  237.         beginning of the selected code sample. You can now step through
  238.         each line of code as it executes, using the appropriate options of
  239.         your debugger.
  240.