Chapter 3. Function Descriptions

Table of Contents

Introduction
Initialising the B Tree library
Creating a B Tree File
Opening a B Tree File
Closing a B Tree File
Set/unset support for duplicate keys
Set write through threshold for index file blocks
Inserting a key
Finding a key
Finding a sequence of keys
Finding a reverse sequence of keys
Setting the position within a B Tree index
Deleting a key
Updating the value of a key
Creating a root
Changing the current root
Deleting a root
Gaining exclusive access to a B Tree file
Releasing exclusive access on a B Tree file
Inserting a key and data
Updating data for an existing key
Locating data for an existing key
Deleting a key and associated data
Locating data for the next key in sequence
Locating data for the previous key in sequence
Determine size of data record for specific key
Debugging information
Retrieving error message text

Introduction

This chapter describes each of the functions offered by the BT API. Rather than present the functions in alphabetic order (as any sensible document would), the functions are described in order of probable usage by an application program. To make it even more difficult to use as a reference manual, the functions are titled by their functionality, not their names.