diff options
Diffstat (limited to 'docs/programmer_reference/csharp.html')
| -rw-r--r-- | docs/programmer_reference/csharp.html | 155 |
1 files changed, 85 insertions, 70 deletions
diff --git a/docs/programmer_reference/csharp.html b/docs/programmer_reference/csharp.html index 6ba247ce..2f2b62d8 100644 --- a/docs/programmer_reference/csharp.html +++ b/docs/programmer_reference/csharp.html @@ -14,7 +14,7 @@ <body> <div xmlns="" class="navheader"> <div class="libver"> - <p>Library Version 11.2.5.3</p> + <p>Library Version 12.1.6.1</p> </div> <table width="100%" summary="Navigation header"> <tr> @@ -48,78 +48,92 @@ </dt> </dl> </div> - <p>You can use Berkeley DB in your application through the C# API. To understand the application concepts relating to Berkeley DB, see the first few chapters of this manual. -For a general discussion on how to build Berkeley DB applications, see the Berkeley DB Getting Started Guides of C or C++. -You can also review the example code of C and C++ from the examples_c and examples_cxx directories. For a description of all the classes, functions, and enumerations of Berkeley DB C# API, see the <a class="ulink" href="http://download.oracle.com/docs/cd/E17076_02/html/csharp/Index.html" target="_top"> - Berkeley DB C# API Reference Guide. - </a></p> <p> - A separate Visual Studio solution is provided to build the Berkeley DB - C# classes, the examples, and the native support library. See - <a href="../installation/build_win_csharp.html#build_win_csharp.title" class="olink">Building the C# API</a> in the Berkeley DB Installation and Build Guide for more information. -</p> + You can use Berkeley DB in your application through the C# + API. To understand the application concepts relating to + Berkeley DB, see the first few chapters of this manual. For a + general discussion on how to build Berkeley DB applications, + see the Berkeley DB Getting Started Guides of C or C++. You + can also review the example code of C and C++ from the + examples/c and examples/cxx directories. For a description of + all the classes, functions, and enumerations of Berkeley DB C# + API, see the <a class="ulink" href="http://docs.oracle.com/cd/E17076_02/html/csharp/Index.html" target="_top"> Berkeley DB C# API Reference Guide. + </a> + </p> <p> - The C# API requires .NET framework version 2.0 or above, and expects that - it has already been installed on your system. For the sake of - discussion, we assume that the Berkeley DB source is in a directory - called db-<span class="emphasis"><em>VERSION</em></span>; for example, you downloaded a - Berkeley DB archive, and you did not change the top-level directory - name. The files related to C# are in four subdirectories of - db-<span class="emphasis"><em>VERSION</em></span>: csharp (the C# source files), - libdb_csharp (the C++ files that provide the "glue" between C# and - Berkeley DB,) examples_csharp (containing all example code) and - test\scr037 (containing NUnit tests for the API). -</p> + A separate Visual Studio solution is provided to build the + Berkeley DB C# classes, the examples, and the native support + library. See <a href="../installation/build_win_csharp.html#build_win_csharp.title" class="olink">Building the C# + API</a> in the Berkeley DB Installation and Build + Guide for more information. + </p> + <p> + The C# API requires .NET framework version 2.0 or above, + and expects that it has already been installed on your system. + For the sake of discussion, we assume that the Berkeley DB + source is in a directory called + db-<span class="emphasis"><em>VERSION</em></span>; for example, you + downloaded a Berkeley DB archive, and you did not change the + top-level directory name. The files related to C# are in four + subdirectories of db-<span class="emphasis"><em>VERSION</em></span>: csharp (the + C# source files), libdb_csharp (the C++ files that provide the + "glue" between C# and Berkeley DB,) examples/csharp + (containing all example code) and test\scr037 (containing + NUnit tests for the API). + </p> <p> - Building the C# API produces a managed assembly - <code class="filename">libdb_dotnet<span class="emphasis"><em>VERSION</em></span>.dll</code>, - containing the API, and two native libraries: - <code class="filename">libdb_csharp<span class="emphasis"><em>VERSION</em></span>.dll</code> and - <code class="filename">libdb<span class="emphasis"><em>VERSION</em></span>.dll</code>. (For all - three files, <span class="emphasis"><em>VERSION</em></span> is [MAJOR][MINOR], i.e. for - version 4.8 the managed assembly is - <code class="filename">libdb_dotnet48.dll</code>.) Following the existing - convention, native libraries are placed in either - <code class="filename">db-<span class="emphasis"><em>VERSION</em></span>\build_windows\Win32</code>or - <code class="filename">db-<span class="emphasis"><em>VERSION</em></span>\build_windows\x64</code>, - depending upon the platform being targeted. In all cases, the managed - assembly will be placed in - <code class="filename">db-<span class="emphasis"><em>VERSION</em></span>\build_windows\AnyCPU</code>. -</p> + Building the C# API produces a managed assembly + <code class="filename">libdb_dotnet<span class="emphasis"><em>VERSION</em></span>.dll</code>, + containing the API, and two native libraries: + <code class="filename">libdb_csharp<span class="emphasis"><em>VERSION</em></span>.dll</code> + and + <code class="filename">libdb<span class="emphasis"><em>VERSION</em></span>.dll</code>. + (For all three files, <span class="emphasis"><em>VERSION</em></span> is + [MAJOR][MINOR], i.e. for version 4.8 the managed assembly is + <code class="filename">libdb_dotnet48.dll</code>.) Following the + existing convention, native libraries are placed in either + <code class="filename">db-<span class="emphasis"><em>VERSION</em></span>\build_windows\Win32</code>or + <code class="filename">db-<span class="emphasis"><em>VERSION</em></span>\build_windows\x64</code>, + depending upon the platform being targeted. In all cases, the + managed assembly will be placed in + <code class="filename">db-<span class="emphasis"><em>VERSION</em></span>\build_windows\AnyCPU</code>. + </p> <p> - Because the C# API uses P/Invoke, for your application to use Berkeley - DB successfully, the .NET framework needs to be able to locate the - native libaries. This means the native libraries need to either be - copied to your application's directory, the Windows or System - directory, or the location of the libraries needs to be added to the - <code class="literal">PATH</code> environment variable. See the MSDN - documentation of the DllImport attribute and Dynamic-Link Library - Search Order for further information. -</p> - <p> - If you get the following exception when you run, the .NET platform probably - is unable to locate the native libraries: -</p> + Because the C# API uses P/Invoke, for your application to + use Berkeley DB successfully, the .NET framework needs to be + able to locate the native libaries. This means the native + libraries need to either be copied to your application's + directory, the Windows or System directory, or the location of + the libraries needs to be added to the <code class="literal">PATH</code> + environment variable. See the MSDN documentation of the + DllImport attribute and Dynamic-Link Library Search Order for + further information. + </p> + <p> + If you get the following exception when you run, the .NET + platform probably is unable to locate the native libraries: + </p> <pre class="programlisting">System.TypeInitializationException</pre> + <p> + To ensure that everything is running correctly, you may + want to try a simple test from the example programs in the + <code class="filename">db-<span class="emphasis"><em>VERSION</em></span>\examples/csharp</code> + directory. + </p> <p> - To ensure that everything is running correctly, you may want to try a - simple test from the example programs in the - <code class="filename">db-<span class="emphasis"><em>VERSION</em></span>\examples_csharp</code> - directory. -</p> - <p> - For example, the ex_access sample program will prompt for text input - lines, which are then stored in a Btree database named - <code class="filename">access.db</code>. It is designed to be run from either - the - <code class="filename">db-<span class="emphasis"><em>VERSION</em></span>\build_windows\Debug</code> - or - <code class="filename">db-<span class="emphasis"><em>VERSION</em></span>\build_windows\Release</code> - directory. Try giving it a few lines of input text and then a blank - line. Before it exits, you should see a list of the lines you entered - display with data items. This is a simple check to make sure the - fundamental configuration is working correctly. -</p> + For example, the ex_access sample program will prompt for + text input lines, which are then stored in a Btree database + named <code class="filename">access.db</code>. It is designed to be run + from either the + <code class="filename">db-<span class="emphasis"><em>VERSION</em></span>\build_windows\Debug</code> + or + <code class="filename">db-<span class="emphasis"><em>VERSION</em></span>\build_windows\Release</code> + directory. Try giving it a few lines of input text and then a + blank line. Before it exits, you should see a list of the + lines you entered display with data items. This is a simple + check to make sure the fundamental configuration is working + correctly. + </p> <div class="sect1" lang="en" xml:lang="en"> <div class="titlepage"> <div> @@ -128,9 +142,10 @@ You can also review the example code of C and C++ from the examples_c and exampl </div> </div> </div> - <p> - The Berkeley DB C# API has been tested with the Microsoft .NET Framework versions 2.0, 3.0, 3.5, and 4.0. -</p> + <p> + The Berkeley DB C# API has been tested with the + Microsoft .NET Framework versions 2.0, 3.0, 3.5, and 4.0. + </p> </div> </div> <div class="navfooter"> |