Topics that the API Guide Covers

Go Up to Using the API Guide

The API Guide is divided into two parts:

• A task-oriented user’s guide that explains how to use API function calls to perform related database tasks, such as attaching to and detaching from a database.
• An API function call reference that describes the purpose of each function, its syntax, its parameters, requirements, restrictions, and return values, as well as examples of use and cross-references to related functions.

The following table provides a brief description of each chapter in the API Guide:

API Guide Chapters

Chapter	Description
Application Requirements	Describes support structures and elements common to programming with API calls
Programming with the InterBase API	Describes special requirements for programming InterBase applications with the InterBase API
Working with Databases	Describes how to attach to and detach from databases, and how to request information about attachments
Working with Transactions	Explains how to start transactions in different modes, and how to commit them or roll them back
Working with Dynamic SQL	Describes how to process DSQL data definition and data manipulation statements using API calls
Working with Blob Data	Describes how to select, insert, update, and delete Blob data in applications
Working with Array Data	Describes how to select, insert, update, and delete array data in applications
Working with Conversions	Describes how to select, insert, update, and delete date and time data in applications, and how to reverse the byte order of numbers with isc_portable_integer()
Handling Error Conditions	Describes how to trap and handle database errors in applications
Working with Events	Explains how triggers interact with applications and describes how to register interest in events, wait on them, and respond to them in applications
Working with Services	Describes the “Services API,” which gives control over functions such as creating new user identifiers, validating the database, backing up the database, and gathering database statistics.
Using the Install and Licensing APIs	Describes the APIs needed to write a silent embedded install and associated licensing.
Exporting XML	Describes how to export to XML.
API Function Reference	Describes the syntax of each function, describes its use, and provides examples.

Advance To:

• Sample Database and Applications