API Guide

Go Up to User Guides

The API Guide provides how-to information on developing InterBase applications using the InterBase API interface. Topics include:

• Application requirements
• Programming with the InterBase API
• Working with databases, transactions, dynamic SQL, blob data, arrays, conversions, and service
• Using the install and licensing APIs
• Exporting XML
• Handling error conditions
• The InterBase API function reference

Chapters

Each chapter in the API Guide are listed in the following table with a brief description and a link to the chapter.

Chapter	Description
Using the API Guide	Describes the focus of this book, and provides a brief overview of its chapters. Who Should Use the API Guide Topics that the API Guide Covers Sample Database and Applications
Application Requirements	Describes support structures and elements common to programming with API calls. Requirements for all Applications Additional Requirements Compiling and Linking
Programming with the InterBase API	Describes special requirements for programming InterBase applications with the InterBase API Basic Procedure for Application Development Supported Development Environments User Name and Password Requirements Specifying User Name and Password Using Environment Variables Data Types Calling Conventions Building Applications
Working with Databases	Describes how to attach to and detach from databases, and how to request information about attachments. Connecting to Databases Requesting Information About an Attachment (API Guide) Disconnecting from Databases Deleting a Database Alphabetical List of DPB Parameters
Working with Transactions	Explains how to start transactions in different modes, and how to commit them or roll them back. Starting Transactions Ending Transactions
Working with Dynamic SQL	Describes how to process DSQL data definition and data manipulation statements using API calls. Overview of the DSQL Programming Process DSQL API Limitations Writing an API Application to Process SQL Statements Understanding the XSQLDA Change View API Support (API Guide) DSQL Programming Methods Determining an Unknown Statement Type at Runtime
Working with Blob Data	Describes how to select, insert, update, and delete Blob data in applications. What is a Blob? Blob Descriptors Populating a Blob Descriptor Blob Data Operations Requesting Information About an Open Blob Filtering Blob Data
Working with Array Data	Describes how to select, insert, update, and delete array data in applications. Introduction to Arrays Accessing Array Data
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() Converting Date and Times from InterBase to C Format Converting Dates from C to InterBase Format Reversing the Byte Order of Numbers
Handling Error Conditions	Describes how to trap and handle database errors in applications. Setting Up an Error Status Vector Using Information in the Status Vector Setting a SQLCODE Value on Error Parsing the Status Vector
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. Understanding the Event Mechanism Creating EPBs with isc_event_block( ) Waiting on Events with isc_wait_for_event() Continuous Processing with isc_que_events() Determining Which Events Occurred with isc_event_counts() Canceling Interest With isc_cancel_events()
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. Overview of the Services API Invoking Service Tasks with isc_service_start( ) Querying the Services Manager Using the Services API with RAD Studio
Exporting XML	Describes how to export to XML. Using the InterBase API to Generate XML A Complete Example
API Function Reference	Describes the syntax of each function, describes its use, and provides examples. Function Categories Using Function Definitions Alphabetic Function List

Advance To:

• Using the API Guide