Interbase ApiGuide

Table of Contents......Page 3
List of Tables......Page 13
Topics covered in this guide......Page 17
Sample database and applications......Page 19
Requirements for all applications......Page 23
Database requirements......Page 24
Transaction requirements......Page 25
Microsoft Windows requirements......Page 26
Blob requirements......Page 27
Event requirements......Page 28
Services requirements......Page 29
Compiling and linking......Page 30
Basic procedure for application development......Page 31
User name and password requirements......Page 32
Using environment variables......Page 33
Calling conventions......Page 34
Compilers......Page 35
Using Microsoft C++......Page 36
Using Borland C/C++......Page 37
Setting up the Integrated Development Environment (IDE)......Page 38
The module definition file......Page 39
Example programs......Page 40
Working with Databases......Page 41
Creating database handles......Page 42
Creating and populating a DPB......Page 43
Adding parameters to a DPB......Page 48
Attaching to a database......Page 50
Requesting buffer items and result buffer values......Page 52
isc_database_info() call example......Page 57
Deleting a database......Page 58
Working with Transactions......Page 61
Starting transactions......Page 62
Creating transaction handles......Page 63
Creating a transaction parameter buffer......Page 64
Calling isc_start_transaction( )......Page 73
Calling isc_start_multiple( )......Page 74
Ending transactions......Page 76
Using isc_commit_transaction( )......Page 77
Using isc_rollback_transaction( )......Page 80
Using isc_rollback_retaining()......Page 81
Overview of the DSQL programming process......Page 83
Accessing databases......Page 84
Handling transactions......Page 85
Creating a database......Page 86
Writing an API application to process SQL statements......Page 87
Representing an SQL statement as a character string......Page 88
Understanding the XSQLDA......Page 89
XSQLDA field descriptions......Page 91
Output descriptors......Page 93
SQL datatype macro constants......Page 94
Handling NUMERIC and DECIMAL datatypes......Page 97
Coercing datatypes......Page 98
DSQL programming methods......Page 99
Method 1: Non-query statements without parameters......Page 100
Method 2: Non-query statements with parameters......Page 101
Method 3: Query statements without parameters......Page 105
Method 4: Query statements with parameters......Page 110
Determining an unknown statement type at runtime......Page 117
Working with Blob Data......Page 119
What is a Blob?......Page 120
Blob subtypes......Page 121
Blob data operations......Page 122
Reading data from a Blob......Page 123
Writing data to a Blob......Page 128
Deleting a Blob......Page 132
Item-list buffer items and result buffer values......Page 133
isc_blob_info( ) call example......Page 135
Blob descriptors......Page 136
Populating a Blob descriptor......Page 137
Using your own filters......Page 138
Writing an external Blob filter......Page 139
Writing an application that requests filtering......Page 144
Working with Array Data......Page 149
Introduction to arrays......Page 150
Array descriptors......Page 151
Populating an array descriptor......Page 152
Reading data from an array......Page 153
Writing data to an array......Page 159
Deleting an array......Page 165
Working with Conversions......Page 167
Converting date and times from InterBase to C format......Page 168
Converting dates from C to InterBase format......Page 169
Reversing byte order of numbers with isc_portable_integer( )......Page 170
Handling Error Conditions......Page 171
Using information in the status vector......Page 172
Displaying InterBase error messages......Page 173
Capturing InterBase error messages......Page 174
Displaying SQL error messages......Page 176
Capturing SQL error messages......Page 177
Parsing the status vector......Page 178
Working with Events......Page 187
Event parameter buffers......Page 188
Transaction control of events......Page 189
Creating EPBs with isc_event_block()......Page 190
Waiting on events with isc_wait_for_event( )......Page 191
Continuous processing with isc_que_events( )......Page 192
A complete isc_que_events( ) example......Page 193
Determining which events occurred with isc_event_counts( )......Page 196
Canceling interest in asynchronous events with isc_cancel_events( )......Page 197
Working with Services......Page 199
Using services parameter buffers......Page 200
Attaching to the Services Manager with isc_service_attach()......Page 202
Detaching from a Services Manager with isc_service_detach()......Page 203
Overview of task identifiers......Page 204
Backing up and restoring databases......Page 205
Setting database properties......Page 210
Invoking database maintenance......Page 213
Requesting database and server status reports......Page 215
Configuring users......Page 217
Administering software activation certificates......Page 220
Services API query example......Page 222
Using result buffers......Page 223
Querying server configuration......Page 225
Querying security configuration......Page 233
Querying service tasks......Page 239
Using the Services API with Delphi and C++Builder......Page 241
About the InterBase Install API......Page 243
The install handle......Page 245
Callback functions......Page 246
Datatypes defined for the Install API......Page 248
Writing an InterBase install......Page 249
Function categories......Page 253
Blob functions......Page 254
Database functions......Page 255
DSQL functions......Page 256
Error-handling functions......Page 257
Information functions......Page 258
Install functions......Page 259
Transaction control functions......Page 260
Using function definitions......Page 261
isc_add_user()......Page 262
isc_array_get_slice()......Page 265
isc_array_lookup_bounds()......Page 270
isc_array_lookup_desc()......Page 273
isc_array_put_slice()......Page 276
isc_array_set_desc()......Page 283
isc_attach_database()......Page 286
isc_blob_default_desc()......Page 289
isc_blob_gen_bpb()......Page 291
isc_blob_info()......Page 292
isc_blob_lookup_desc()......Page 294
isc_blob_set_desc()......Page 295
isc_cancel_blob()......Page 297
isc_cancel_events()......Page 298
isc_close_blob()......Page 299
isc_commit_retaining()......Page 300
isc_commit_transaction()......Page 302
isc_create_blob2()......Page 303
isc_database_info()......Page 305
isc_decode_sql_date()......Page 308
isc_decode_sql_time()......Page 309
isc_decode_timestamp()......Page 310
isc_delete_user()......Page 311
isc_detach_database()......Page 314
isc_drop_database()......Page 315
isc_dsql_allocate_statement()......Page 316
isc_dsql_alloc_statement2()......Page 317
isc_dsql_describe()......Page 319
isc_dsql_describe_bind()......Page 322
isc_dsql_execute()......Page 324
isc_dsql_execute2()......Page 329
isc_dsql_execute_immediate()......Page 332
isc_dsql_exec_immed2()......Page 335
isc_dsql_fetch()......Page 337
isc_dsql_free_statement()......Page 341
isc_dsql_prepare()......Page 343
isc_dsql_set_cursor_name()......Page 346
isc_dsql_sql_info()......Page 349
isc_encode_sql_date()......Page 350
isc_encode_sql_time()......Page 352
isc_encode_timestamp()......Page 353
isc_event_block()......Page 354
isc_event_counts()......Page 355
isc_expand_dpb()......Page 358
isc_get_segment()......Page 359
isc_install_clear_options()......Page 361
isc_install_execute()......Page 362
isc_install_get_info()......Page 364
isc_install_load_external_text()......Page 366
isc_install_precheck()......Page 367
isc_install_set_option()......Page 369
isc_install_unset_option()......Page 370
isc_uninstall_execute()......Page 371
isc_interprete()......Page 372
isc_modify_user()......Page 374
isc_open_blob2()......Page 377
isc_portable_integer()......Page 379
isc_prepare_transaction()......Page 380
isc_prepare_transaction2()......Page 382
isc_print_sqlerror()......Page 383
isc_print_status()......Page 384
isc_put_segment()......Page 385
isc_que_events()......Page 387
isc_rollback_retaining()......Page 391
isc_rollback_transaction()......Page 393
isc_service_attach()......Page 394
isc_service_detach()......Page 395
isc_service_query()......Page 396
isc_service_start()......Page 398
isc_sql_interprete()......Page 399
isc_start_multiple()......Page 400
isc_start_transaction()......Page 404
isc_transaction_info()......Page 406
isc_vax_integer()......Page 409
isc_version()......Page 410
isc_wait_for_event()......Page 412
InterBase Document Conventions......Page 415
Printing conventions......Page 416
Syntax conventions......Page 417
Data Structures......Page 419
Array descriptor......Page 420
Blob descriptor......Page 421
Blob information buffers......Page 422
Blob buffer items......Page 423
Blob parameter buffer......Page 424
Database information request buffer and result buffer......Page 425
Result buffer......Page 426
Request buffer items and result buffer values......Page 427
SQL datatype macro constants......Page 435
Meaning of the first long in a cluster......Page 437
Transaction parameter buffer......Page 439
XSQLDA and XSQLVAR......Page 442
XSQLVAR field descriptions......Page 444
Index......Page 447