Developer Guide |
|
FairCom DB API API for C# - Developers Guide |
|
Audience: |
Developers |
Subject: |
Developing applications using the FairCom DB API .NET Database API |
Copyright: |
© Copyright 2025, FairCom Corporation. All rights reserved. For full information, see the FairCom Copyright Notice. |
FairCom is pleased to present the FairCom DB API API component for the Microsoft® .NET Framework ("FairCom DB API .NET").
Microsoft .NET is software for connecting people, information, systems, and devices. FairCom DB API .NET gives application developers a simple interface into the powerful core of FairCom DB API, yet includes the advanced functionality that distinguishes FairCom DB API from other database solutions. FairCom DB API .NET offers a method of database creation and maintenance that is easier to use than the c-tree ISAM and low-level APIs, which require C programming language and unmanaged code. FairCom DB API .NET utilizes the simplified concepts of sessions, databases, and tables in addition to the standard concepts of records, fields, indexes, and segments. This database API allows for effortless and productive management of database systems.
FairCom DB API .NET is a component that integrates with VB .NET, C#, J#, Delphi .NET and others. This component exposes the methods and properties of the FairCom DB API .NET Class Level API and Function Level API. Please refer to the following chapters for a comprehensive listing of all the methods and properties that encompasses this API.
Background
This section is designed to offer just a taste of the Function Level API. If you have never developed with this API, it will be beneficial to take a moment to learn some of the basics. This will be especially useful when we begin building our first FairCom DB API .NET application.
Below we will list the API function calls necessary to connect to a database, open a table, and add a record. This exercise is meant to expose the more commonly used APIs and follow the sequence of calls to be performed for most database tasks.
The nomenclature for the Function Level API is to prefix "ctdb." to all function names. For example, AllocSession() is ctdbAllocSession() in FairCom DB API and ctdb.AllocSession() in .NET.
In the .NET IDE, once the ‘.’ (period) after "ctdb" is typed, then IntelliSense® will take over and present a drop-down of properties and methods.