diff --git a/books/CSharp-readme.html b/books/CSharp-readme.html new file mode 100644 index 0000000..37fc771 --- /dev/null +++ b/books/CSharp-readme.html @@ -0,0 +1,255 @@ + +
+Copyright ©1988-2007 Sequiter Inc. All rights reserved.
+ +This document contains useful information on how to use the CodeBase CSharp API with +Microsoft Visual Studio.
+ +The files within this ZIP file are intended to add C# support to the base CodeBase for Windows installation. Before extracting this ZIP file, download and install one of the builds on the CodeBase for Windows download page.
+ +Once you have downloaded and installed one of the builds on the CodeBase for Windows download page, extract this ZIP file to the same location as where you installed CodeBase for Windows. For example, if you installed CodeBase to C:\codebase\, extract this ZIP file to C:\codebase\. + +
After extracting this ZIP file, you should have +the following additional files and folders. (The list below includes only the files and folders that this ZIP file adds to the CodeBase installation; it does not describe the components of the base CodeBase installation.
+ +C:\codebase | ++ |
\books | ++ |
+ CSharp_Reference_Guide.chm + CSharp_User_Guide.chm + |
+ Documentation for the CodeBase C# API | +
\examples | ++ |
\Source | ++ |
\CSharp | +Sample source code featured in the documentation. | +
\source | ++ |
+ codebase.cs + | +CodeBase class module | +
To use CodeBase in a C# project, use the Project|Add Existing Item... +menu command in your Visual Studio IDE to add codebase.cs to the +project. Then, add
+ +using CodeBase;
+ +to your source code files that will be using the CodeBase C# classes.
+ +After you have built your C# application, copy the files in CodeBase's DLL32 folder to a location where +your application can access it, ideally in the same folder as the +application or in the Windows System32 folder.
+ +The examples featured in the documentation are included as +.CS files in the Examples\Source\CSharp +folder.
+ +To build and run these examples, the project c4ap.csproj has +been included for you in the Examples\Projects\CSharp folder. +The c4ap project +includes a dummy source file called example.cs. To build one of the +examples, you would do one of the following.
+ +If you have been using CodeBase previously with C++ and are making a +transition to C#, the following information will be useful for understanding +the differences between the two.
+ +This version of CodeBase for C# includes classes corresponding to the most +often used classes from the C++ version:
+ +Almost all the class descriptions in the CodeBase C++ Reference Guide are applicable +to the C# classes. The minor differences are outlined below:
+ +In the C++ API | +In the C# API | +
---|---|
+ Parameters and return values + implemented as long data type (e.g. Data4::go(long)) + | ++ Implemented as int data type + (e.g. Data4::go(int)) + | +
+ Parameters and return values + implemented as char pointer (e.g. char *Data4::alias()) + | ++ Implemented as string (e.g. string Data4::alias()) + | +
Constants (e.g. r4success) | ++ Constant members of the Code4 class + (e.g. Code4.r4success) + | +
Code4::unlockAuto(), Code4::unlockAuto(int) | +Code4.unlockAuto class property | +
Data4::check() | +Data4.checkIndex() | +
Data4::lock() | +Data4.lockRecord() | +
Data4::log() | +Data4.log class property | +
Data4::position(), Data4::position(double) | +Data4.position class property | +
Data4::record() | +Not available | +
Expr4::null() | +Expr4.isNull() | +
Expr4::true() | +Expr4.isTrue() | +
Field4::assignLong(long) | +Not available | +
Field4::operator char | +Field4.getChar() | +
Field4::operator double | +Field4.getDouble() | +
Field4::operator int | +Field4.getInt() | +
Field4::operator long | +Not available | +
Field4::null() | +Field4.isNull() | +
Field4::true() | +Field4.isTrue() | +
Field4::ptr() | +Not available | +
Index4::create() | +Not available; index creation is done through the Data4::create() method | +
Index4::tagAdd() | +Not available | +