← Back to branch summary

~ubuntu-branches/ubuntu/maverick/libdbi/maverick-proposed

« back to all changes in this revision

Viewing changes to doc/programmers-guide/reference-driver.html

  • Committer: Bazaar Package Importer
  • Author(s): Thomas Goirand
  • Date: 2007-11-26 05:53:13 UTC
  • mfrom: (1.1.1 upstream)
  • Revision ID: james.westby@ubuntu.com-20071126055313-29bzt00k533rgkg8
Tags: 0.8.2-3
http://bugs.debian.org/444424
* New maintainer (Closes: #444424)
* Now cleaning everything correctly on the clean target
* Now managing updates of config.sub and config.guess correctly
* Removed useless postinst and postrm from debian folder as they are
  generated by dh_makeshlibs anyway
* Cleaned a bit the debian/rules for readability
* Reviewed the debian/copyright for accuracy

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/programmers-guide/reference-driver.html
1
 
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
 
1
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2
2
<HTML
3
3
><HEAD
4
4
><TITLE
5
5
>Driver Infrastructure</TITLE
6
6
><META
7
7
NAME="GENERATOR"
8
 
CONTENT="Modular DocBook HTML Stylesheet Version 1.7"><LINK
 
8
CONTENT="Modular DocBook HTML Stylesheet Version 1.79"><LINK
9
9
REL="HOME"
10
10
TITLE="Database Independent Abstraction Layer for C"
11
11
HREF="index.html"><LINK
37
37
><TH
38
38
COLSPAN="3"
39
39
ALIGN="center"
40
 
>Database Independent Abstraction Layer for C: libdbi Programmer's Guide (OUTDATED SEE README!)</TH
 
40
>Database Independent Abstraction Layer for C: libdbi Programmer's Guide</TH
41
41
></TR
42
42
><TR
43
43
><TD
84
84
NAME="DBI-DRIVER-LIST"
85
85
>3.2.1. dbi_driver_list</A
86
86
></H2
87
 
><P
88
 
><TABLE
89
 
BORDER="0"
90
 
BGCOLOR="#E0E0E0"
91
 
WIDTH="100%"
92
 
><TR
93
 
><TD
94
 
><FONT
95
 
COLOR="#000000"
96
 
><PRE
97
 
CLASS="PROGRAMLISTING"
98
 
>dbi_driver dbi_driver_list(dbi_driver Current)</PRE
99
 
></FONT
100
 
></TD
101
 
></TR
102
 
></TABLE
103
 
></P
 
87
><DIV
 
88
CLASS="FUNCSYNOPSIS"
 
89
><P
 
90
></P
 
91
><A
 
92
NAME="AEN340"
 
93
></A
 
94
><P
 
95
><CODE
 
96
><CODE
 
97
CLASS="FUNCDEF"
 
98
>dbi_driver <B
 
99
CLASS="FSFUNC"
 
100
>dbi_driver_list</B
 
101
></CODE
 
102
>(dbi_driver <VAR
 
103
CLASS="PDPARAM"
 
104
>Current</VAR
 
105
>);</CODE
 
106
></P
 
107
><P
 
108
></P
 
109
></DIV
104
110
><P
105
111
>Enumerates all loaded drivers. If Current is NULL, the first available driver will be returned. If Current is a valid driver, the next available driver will be returned.</P
106
112
><P
109
115
CLASS="VARIABLELIST"
110
116
><DL
111
117
><DT
112
 
><EM
113
 
>Arguments</EM
114
 
></DT
 
118
>Arguments</DT
115
119
><DD
116
120
><P
117
 
><VAR
 
121
><TT
118
122
CLASS="LITERAL"
119
 
>Current</VAR
 
123
>Current</TT
120
124
>: The current driver in the list of drivers.</P
121
125
></DD
122
126
><DT
123
 
><EM
124
 
>Returns</EM
125
 
></DT
 
127
>Returns</DT
126
128
><DD
127
129
><P
128
130
>The next available driver, or NULL if there is an error or no more are available.</P
138
140
NAME="DBI-DRIVER-OPEN"
139
141
>3.2.2. dbi_driver_open</A
140
142
></H2
141
 
><P
142
 
><TABLE
143
 
BORDER="0"
144
 
BGCOLOR="#E0E0E0"
145
 
WIDTH="100%"
146
 
><TR
147
 
><TD
148
 
><FONT
149
 
COLOR="#000000"
150
 
><PRE
151
 
CLASS="PROGRAMLISTING"
152
 
>dbi_driver dbi_driver_open(const char *name)</PRE
153
 
></FONT
154
 
></TD
155
 
></TR
156
 
></TABLE
157
 
></P
 
143
><DIV
 
144
CLASS="FUNCSYNOPSIS"
 
145
><P
 
146
></P
 
147
><A
 
148
NAME="AEN359"
 
149
></A
 
150
><P
 
151
><CODE
 
152
><CODE
 
153
CLASS="FUNCDEF"
 
154
>dbi_driver <B
 
155
CLASS="FSFUNC"
 
156
>dbi_driver_open</B
 
157
></CODE
 
158
>(const char *<VAR
 
159
CLASS="PDPARAM"
 
160
>name</VAR
 
161
>);</CODE
 
162
></P
 
163
><P
 
164
></P
 
165
></DIV
158
166
><P
159
167
>Locate the driver with the specified name.</P
160
168
><P
163
171
CLASS="VARIABLELIST"
164
172
><DL
165
173
><DT
166
 
><EM
167
 
>Arguments</EM
168
 
></DT
 
174
>Arguments</DT
169
175
><DD
170
176
><P
171
 
><VAR
 
177
><TT
172
178
CLASS="LITERAL"
173
 
>name</VAR
 
179
>name</TT
174
180
>: The name of the driver to open.</P
175
181
></DD
176
182
><DT
177
 
><EM
178
 
>Returns</EM
179
 
></DT
 
183
>Returns</DT
180
184
><DD
181
185
><P
182
186
>The requested driver, or NULL if there is an error or it is not found.</P
192
196
NAME="DBI-DRIVER-IS-RESERVED-WORD"
193
197
>3.2.3. dbi_driver_is_reserved_word</A
194
198
></H2
195
 
><P
196
 
><TABLE
197
 
BORDER="0"
198
 
BGCOLOR="#E0E0E0"
199
 
WIDTH="100%"
200
 
><TR
201
 
><TD
202
 
><FONT
203
 
COLOR="#000000"
204
 
><PRE
205
 
CLASS="PROGRAMLISTING"
206
 
>int dbi_driver_is_reserved_word(dbi_driver Driver, const char *word)</PRE
207
 
></FONT
208
 
></TD
209
 
></TR
210
 
></TABLE
211
 
></P
 
199
><DIV
 
200
CLASS="FUNCSYNOPSIS"
 
201
><P
 
202
></P
 
203
><A
 
204
NAME="AEN378"
 
205
></A
 
206
><P
 
207
><CODE
 
208
><CODE
 
209
CLASS="FUNCDEF"
 
210
>int <B
 
211
CLASS="FSFUNC"
 
212
>dbi_driver_is_reserved_word</B
 
213
></CODE
 
214
>(dbi_driver <VAR
 
215
CLASS="PDPARAM"
 
216
>Driver</VAR
 
217
>, const char *<VAR
 
218
CLASS="PDPARAM"
 
219
>word</VAR
 
220
>);</CODE
 
221
></P
 
222
><P
 
223
></P
 
224
></DIV
212
225
><P
213
226
>Looks for the specified word in the list of reserved words. The result of this function may vary between databases. Case does not matter.</P
214
227
><P
217
230
CLASS="VARIABLELIST"
218
231
><DL
219
232
><DT
220
 
><EM
221
 
>Arguments</EM
222
 
></DT
 
233
>Arguments</DT
223
234
><DD
224
235
><P
225
 
><VAR
 
236
><TT
226
237
CLASS="LITERAL"
227
 
>Driver</VAR
 
238
>Driver</TT
228
239
>: The target driver.</P
229
240
><P
230
 
><VAR
 
241
><TT
231
242
CLASS="LITERAL"
232
 
>word</VAR
 
243
>word</TT
233
244
>: The word to check against the reserved word list.</P
234
245
></DD
235
246
><DT
236
 
><EM
237
 
>Returns</EM
238
 
></DT
 
247
>Returns</DT
239
248
><DD
240
249
><P
241
250
>-1 if an error occurs, 0 if the word is not reserved, 1 otherwise.</P
251
260
NAME="DBI-DRIVER-SPECIFIC-FUNCTION"
252
261
>3.2.4. dbi_driver_specific_function</A
253
262
></H2
254
 
><P
255
 
><TABLE
256
 
BORDER="0"
257
 
BGCOLOR="#E0E0E0"
258
 
WIDTH="100%"
259
 
><TR
260
 
><TD
261
 
><FONT
262
 
COLOR="#000000"
263
 
><PRE
264
 
CLASS="PROGRAMLISTING"
265
 
>void *dbi_driver_specific_function(dbi_driver Driver, const char *name)</PRE
266
 
></FONT
267
 
></TD
268
 
></TR
269
 
></TABLE
270
 
></P
 
263
><DIV
 
264
CLASS="FUNCSYNOPSIS"
 
265
><P
 
266
></P
 
267
><A
 
268
NAME="AEN401"
 
269
></A
 
270
><P
 
271
><CODE
 
272
><CODE
 
273
CLASS="FUNCDEF"
 
274
>void *<B
 
275
CLASS="FSFUNC"
 
276
>dbi_driver_specific_function</B
 
277
></CODE
 
278
>(dbi_driver <VAR
 
279
CLASS="PDPARAM"
 
280
>Driver</VAR
 
281
>, const char *<VAR
 
282
CLASS="PDPARAM"
 
283
>name</VAR
 
284
>);</CODE
 
285
></P
 
286
><P
 
287
></P
 
288
></DIV
271
289
><P
272
290
>Returns a function pointer to the specifed custom function. This can be used to access database-specific functionality, but it will restrict your code to one particular database, lessening the benefits of using libdbi.</P
273
291
><P
276
294
CLASS="VARIABLELIST"
277
295
><DL
278
296
><DT
279
 
><EM
280
 
>Arguments</EM
281
 
></DT
 
297
>Arguments</DT
282
298
><DD
283
299
><P
284
 
><VAR
 
300
><TT
285
301
CLASS="LITERAL"
286
 
>Driver</VAR
 
302
>Driver</TT
287
303
>: The target driver.</P
288
304
><P
289
 
><VAR
 
305
><TT
290
306
CLASS="LITERAL"
291
 
>name</VAR
 
307
>name</TT
292
308
>: The name of the custom function.</P
293
309
></DD
294
310
><DT
295
 
><EM
296
 
>Returns</EM
297
 
></DT
 
311
>Returns</DT
298
312
><DD
299
313
><P
300
314
>If the custom function is found, a pointer to that function. If not, returns NULL.</P
310
324
NAME="DBI-DRIVER-QUOTE-STRING"
311
325
>3.2.5. dbi_driver_quote_string</A
312
326
></H2
313
 
><P
314
 
><TABLE
315
 
BORDER="0"
316
 
BGCOLOR="#E0E0E0"
317
 
WIDTH="100%"
318
 
><TR
319
 
><TD
320
 
><FONT
321
 
COLOR="#000000"
322
 
><PRE
323
 
CLASS="PROGRAMLISTING"
324
 
>int dbi_driver_quote_string(dbi_driver Driver, char **orig)</PRE
325
 
></FONT
326
 
></TD
327
 
></TR
328
 
></TABLE
329
 
></P
330
 
><P
331
 
>Encloses the target string in the types of quotes that the database expects, and escapes any special characters. The original string will be freed and will point to a newly allocated one (which you still must free on your own).</P
 
327
><DIV
 
328
CLASS="FUNCSYNOPSIS"
 
329
><P
 
330
></P
 
331
><A
 
332
NAME="AEN424"
 
333
></A
 
334
><P
 
335
><CODE
 
336
><CODE
 
337
CLASS="FUNCDEF"
 
338
>int <B
 
339
CLASS="FSFUNC"
 
340
>dbi_driver_quote_string</B
 
341
></CODE
 
342
>(dbi_driver <VAR
 
343
CLASS="PDPARAM"
 
344
>Driver</VAR
 
345
>, <VAR
 
346
CLASS="PDPARAM"
 
347
>char **orig</VAR
 
348
>);</CODE
 
349
></P
 
350
><P
 
351
></P
 
352
></DIV
 
353
><P
 
354
>Encloses the target string in the types of quotes that the database expects, and escapes any special characters. The original string will be freed and <CODE
 
355
CLASS="PARAMETER"
 
356
>orig</CODE
 
357
> will point to a newly allocated one (which you still must free on your own). If an error occurs, the original string will not be freed.</P
 
358
><DIV
 
359
CLASS="NOTE"
 
360
><BLOCKQUOTE
 
361
CLASS="NOTE"
 
362
><P
 
363
><B
 
364
>Note: </B
 
365
>This function is deprecated. Use <A
 
366
HREF="reference-query.html#DBI-CONN-QUOTE-STRING"
 
367
>dbi_conn_quote_string</A
 
368
> instead.</P
 
369
></BLOCKQUOTE
 
370
></DIV
332
371
><P
333
372
></P
334
373
><DIV
335
374
CLASS="VARIABLELIST"
336
375
><DL
337
376
><DT
338
 
><EM
339
 
>Arguments</EM
340
 
></DT
 
377
>Arguments</DT
341
378
><DD
342
379
><P
343
 
><VAR
 
380
><TT
344
381
CLASS="LITERAL"
345
 
>Driver</VAR
 
382
>Driver</TT
346
383
>: The target driver.</P
347
384
><P
348
 
><VAR
 
385
><TT
349
386
CLASS="LITERAL"
 
387
>orig</TT
 
388
>: A pointer to the string to quote and escape.</P
 
389
></DD
 
390
><DT
 
391
>Returns</DT
 
392
><DD
 
393
><P
 
394
>The new string's length in bytes, excluding the terminating zero byte, or 0 in case of an error. The length of a quoted empty string is 2 bytes.</P
 
395
></DD
 
396
></DL
 
397
></DIV
 
398
></DIV
 
399
><DIV
 
400
CLASS="SECTION"
 
401
><H2
 
402
CLASS="SECTION"
 
403
><A
 
404
NAME="DBI-DRIVER-QUOTE-STRING-COPY"
 
405
>3.2.6. dbi_driver_quote_string_copy</A
 
406
></H2
 
407
><DIV
 
408
CLASS="FUNCSYNOPSIS"
 
409
><P
 
410
></P
 
411
><A
 
412
NAME="AEN451"
 
413
></A
 
414
><P
 
415
><CODE
 
416
><CODE
 
417
CLASS="FUNCDEF"
 
418
>int <B
 
419
CLASS="FSFUNC"
 
420
>dbi_driver_quote_string_copy</B
 
421
></CODE
 
422
>(dbi_driver <VAR
 
423
CLASS="PDPARAM"
 
424
>Driver</VAR
 
425
>, char **<VAR
 
426
CLASS="PDPARAM"
350
427
>orig</VAR
 
428
>, char **<VAR
 
429
CLASS="PDPARAM"
 
430
>newstr</VAR
 
431
>);</CODE
 
432
></P
 
433
><P
 
434
></P
 
435
></DIV
 
436
><P
 
437
>Encloses the target string in the types of quotes that the database expects, and escapes any special characters. The original string will be left alone, and <CODE
 
438
CLASS="PARAMETER"
 
439
>newstr</CODE
 
440
> will point to a newly allocated string containing the quoted string (which you still must free on your own). In case of an error, <CODE
 
441
CLASS="PARAMETER"
 
442
>newstr</CODE
 
443
> is an invalid pointer which you must not attempt to deallocate.</P
 
444
><DIV
 
445
CLASS="NOTE"
 
446
><BLOCKQUOTE
 
447
CLASS="NOTE"
 
448
><P
 
449
><B
 
450
>Note: </B
 
451
>This function is deprecated. Use <A
 
452
HREF="reference-query.html#DBI-CONN-QUOTE-STRING-COPY"
 
453
>dbi_conn_quote_string_copy</A
 
454
> instead.</P
 
455
></BLOCKQUOTE
 
456
></DIV
 
457
><P
 
458
></P
 
459
><DIV
 
460
CLASS="VARIABLELIST"
 
461
><DL
 
462
><DT
 
463
>Arguments</DT
 
464
><DD
 
465
><P
 
466
><TT
 
467
CLASS="LITERAL"
 
468
>Driver</TT
 
469
>: The target driver.</P
 
470
><P
 
471
><TT
 
472
CLASS="LITERAL"
 
473
>orig</TT
351
474
>: A pointer to the string to quote and escape.</P
352
 
></DD
353
 
><DT
354
 
><EM
355
 
>Returns</EM
356
 
></DT
357
 
><DD
358
 
><P
359
 
>The new string's length.</P
 
475
><P
 
476
><TT
 
477
CLASS="LITERAL"
 
478
>newstr</TT
 
479
>: After the function returns, this pointer will point to the quoted and escaped string.</P
 
480
></DD
 
481
><DT
 
482
>Returns</DT
 
483
><DD
 
484
><P
 
485
>The quoted string's length in bytes, excluding the terminating zero byte, or 0 in case of an error. The length of a quoted empty string is 2 bytes.</P
 
486
></DD
 
487
></DL
 
488
></DIV
 
489
></DIV
 
490
><DIV
 
491
CLASS="SECTION"
 
492
><H2
 
493
CLASS="SECTION"
 
494
><A
 
495
NAME="DBI-DRIVER-ENCODING-FROM-IANA"
 
496
>3.2.7. dbi_driver_encoding_from_iana</A
 
497
></H2
 
498
><DIV
 
499
CLASS="FUNCSYNOPSIS"
 
500
><P
 
501
></P
 
502
><A
 
503
NAME="AEN483"
 
504
></A
 
505
><P
 
506
><CODE
 
507
><CODE
 
508
CLASS="FUNCDEF"
 
509
>const char *<B
 
510
CLASS="FSFUNC"
 
511
>dbi_driver_encoding_from_iana</B
 
512
></CODE
 
513
>(dbi_driver <VAR
 
514
CLASS="PDPARAM"
 
515
>Driver</VAR
 
516
>, const char *<VAR
 
517
CLASS="PDPARAM"
 
518
>iana_encoding</VAR
 
519
>);</CODE
 
520
></P
 
521
><P
 
522
></P
 
523
></DIV
 
524
><P
 
525
>Requests the database engine specific name of the character encoding identified by its name as known to <A
 
526
HREF="http://www.iana.org"
 
527
TARGET="_top"
 
528
>IANA</A
 
529
>. Use this function to pass the database engine specific encoding name to SQL queries , e.g. as part of a <B
 
530
CLASS="COMMAND"
 
531
>CREATE DATABASE</B
 
532
> command.</P
 
533
><P
 
534
></P
 
535
><DIV
 
536
CLASS="VARIABLELIST"
 
537
><DL
 
538
><DT
 
539
>Arguments</DT
 
540
><DD
 
541
><P
 
542
><TT
 
543
CLASS="LITERAL"
 
544
>Driver</TT
 
545
>: The target driver.</P
 
546
><P
 
547
><TT
 
548
CLASS="LITERAL"
 
549
>iana_encoding</TT
 
550
>: The IANA name of the character encoding.</P
 
551
></DD
 
552
><DT
 
553
>Returns</DT
 
554
><DD
 
555
><P
 
556
>A string containing the database engine specific encoding name. If the encoding name cannot be translated, the IANA name is returned without translation.</P
 
557
></DD
 
558
></DL
 
559
></DIV
 
560
></DIV
 
561
><DIV
 
562
CLASS="SECTION"
 
563
><H2
 
564
CLASS="SECTION"
 
565
><A
 
566
NAME="DBI-DRIVER-ENCODING-TO-IANA"
 
567
>3.2.8. dbi_driver_encoding_to_iana</A
 
568
></H2
 
569
><DIV
 
570
CLASS="FUNCSYNOPSIS"
 
571
><P
 
572
></P
 
573
><A
 
574
NAME="AEN508"
 
575
></A
 
576
><P
 
577
><CODE
 
578
><CODE
 
579
CLASS="FUNCDEF"
 
580
>const char *<B
 
581
CLASS="FSFUNC"
 
582
>dbi_driver_encoding_to_iana</B
 
583
></CODE
 
584
>(dbi_driver <VAR
 
585
CLASS="PDPARAM"
 
586
>Driver</VAR
 
587
>, const char *<VAR
 
588
CLASS="PDPARAM"
 
589
>db_encoding</VAR
 
590
>);</CODE
 
591
></P
 
592
><P
 
593
></P
 
594
></DIV
 
595
><P
 
596
>Requests the <A
 
597
HREF="http://www.iana.org"
 
598
TARGET="_top"
 
599
>IANA</A
 
600
> name of the character encoding identified by its database engine specific name. Use this function to convert the database engine specific name returned by SQL queries  to the corresponding common name.</P
 
601
><P
 
602
></P
 
603
><DIV
 
604
CLASS="VARIABLELIST"
 
605
><DL
 
606
><DT
 
607
>Arguments</DT
 
608
><DD
 
609
><P
 
610
><TT
 
611
CLASS="LITERAL"
 
612
>Driver</TT
 
613
>: The target driver.</P
 
614
><P
 
615
><TT
 
616
CLASS="LITERAL"
 
617
>db_encoding</TT
 
618
>: The database engine specific name of the character encoding.</P
 
619
></DD
 
620
><DT
 
621
>Returns</DT
 
622
><DD
 
623
><P
 
624
>A string containing the IANA encoding name. If the encoding name cannot be translated, the database engine specific name is returned without translation.</P
360
625
></DD
361
626
></DL
362
627
></DIV
367
632
CLASS="SECTION"
368
633
><A
369
634
NAME="REFERENCE-DRIVER-INFO"
370
 
>3.2.6. Driver Information</A
 
635
>3.2.9. Driver Information</A
371
636
></H2
372
637
><DIV
373
638
CLASS="SECTION"
375
640
CLASS="SECTION"
376
641
><A
377
642
NAME="DBI-DRIVER-GET-NAME"
378
 
>3.2.6.1. dbi_driver_get_name</A
 
643
>3.2.9.1. dbi_driver_get_name</A
379
644
></H3
380
 
><P
381
 
><TABLE
382
 
BORDER="0"
383
 
BGCOLOR="#E0E0E0"
384
 
WIDTH="100%"
385
 
><TR
386
 
><TD
387
 
><FONT
388
 
COLOR="#000000"
389
 
><PRE
390
 
CLASS="PROGRAMLISTING"
391
 
>const char *dbi_driver_get_name(dbi_driver Driver)</PRE
392
 
></FONT
393
 
></TD
394
 
></TR
395
 
></TABLE
396
 
></P
 
645
><DIV
 
646
CLASS="FUNCSYNOPSIS"
 
647
><P
 
648
></P
 
649
><A
 
650
NAME="AEN534"
 
651
></A
 
652
><P
 
653
><CODE
 
654
><CODE
 
655
CLASS="FUNCDEF"
 
656
>const char *<B
 
657
CLASS="FSFUNC"
 
658
>dbi_driver_get_name</B
 
659
></CODE
 
660
>(dbi_driver <VAR
 
661
CLASS="PDPARAM"
 
662
>Driver</VAR
 
663
>);</CODE
 
664
></P
 
665
><P
 
666
></P
 
667
></DIV
397
668
><P
398
669
>Requests the name of the specified driver. The calling program must not attempt to free the returned string.</P
399
670
><P
402
673
CLASS="VARIABLELIST"
403
674
><DL
404
675
><DT
405
 
><EM
406
 
>Arguments</EM
407
 
></DT
 
676
>Arguments</DT
408
677
><DD
409
678
><P
410
 
><VAR
 
679
><TT
411
680
CLASS="LITERAL"
412
 
>Driver</VAR
 
681
>Driver</TT
413
682
>: The target driver.</P
414
683
></DD
415
684
><DT
416
 
><EM
417
 
>Returns</EM
418
 
></DT
 
685
>Returns</DT
419
686
><DD
420
687
><P
421
688
>A string containing the driver's name.</P
429
696
CLASS="SECTION"
430
697
><A
431
698
NAME="DBI-DRIVER-GET-FILENAME"
432
 
>3.2.6.2. dbi_driver_get_filename</A
 
699
>3.2.9.2. dbi_driver_get_filename</A
433
700
></H3
434
 
><P
435
 
><TABLE
436
 
BORDER="0"
437
 
BGCOLOR="#E0E0E0"
438
 
WIDTH="100%"
439
 
><TR
440
 
><TD
441
 
><FONT
442
 
COLOR="#000000"
443
 
><PRE
444
 
CLASS="PROGRAMLISTING"
445
 
>const char *dbi_driver_get_filename(dbi_driver Driver)</PRE
446
 
></FONT
447
 
></TD
448
 
></TR
449
 
></TABLE
450
 
></P
 
701
><DIV
 
702
CLASS="FUNCSYNOPSIS"
 
703
><P
 
704
></P
 
705
><A
 
706
NAME="AEN553"
 
707
></A
 
708
><P
 
709
><CODE
 
710
><CODE
 
711
CLASS="FUNCDEF"
 
712
>const char *<B
 
713
CLASS="FSFUNC"
 
714
>dbi_driver_get_filename</B
 
715
></CODE
 
716
>(dbi_driver <VAR
 
717
CLASS="PDPARAM"
 
718
>Driver</VAR
 
719
>);</CODE
 
720
></P
 
721
><P
 
722
></P
 
723
></DIV
451
724
><P
452
725
>Requests the filename of the specified driver. The calling program must not attempt to free the returned string.</P
453
726
><P
456
729
CLASS="VARIABLELIST"
457
730
><DL
458
731
><DT
459
 
><EM
460
 
>Arguments</EM
461
 
></DT
 
732
>Arguments</DT
462
733
><DD
463
734
><P
464
 
><VAR
 
735
><TT
465
736
CLASS="LITERAL"
466
 
>Driver</VAR
 
737
>Driver</TT
467
738
>: The target driver.</P
468
739
></DD
469
740
><DT
470
 
><EM
471
 
>Returns</EM
472
 
></DT
 
741
>Returns</DT
473
742
><DD
474
743
><P
475
744
>A string containing the driver's full path and file name.</P
483
752
CLASS="SECTION"
484
753
><A
485
754
NAME="DBI-DRIVER-GET-DESCRIPTION"
486
 
>3.2.6.3. dbi_driver_get_description</A
 
755
>3.2.9.3. dbi_driver_get_description</A
487
756
></H3
488
 
><P
489
 
><TABLE
490
 
BORDER="0"
491
 
BGCOLOR="#E0E0E0"
492
 
WIDTH="100%"
493
 
><TR
494
 
><TD
495
 
><FONT
496
 
COLOR="#000000"
497
 
><PRE
498
 
CLASS="PROGRAMLISTING"
499
 
>const char *dbi_driver_get_description(dbi_driver Driver)</PRE
500
 
></FONT
501
 
></TD
502
 
></TR
503
 
></TABLE
504
 
></P
 
757
><DIV
 
758
CLASS="FUNCSYNOPSIS"
 
759
><P
 
760
></P
 
761
><A
 
762
NAME="AEN572"
 
763
></A
 
764
><P
 
765
><CODE
 
766
><CODE
 
767
CLASS="FUNCDEF"
 
768
>const char *<B
 
769
CLASS="FSFUNC"
 
770
>dbi_driver_get_description</B
 
771
></CODE
 
772
>(dbi_driver Driver);</CODE
 
773
></P
 
774
><P
 
775
></P
 
776
></DIV
505
777
><P
506
778
>Requests a description of the specified driver. The calling program must not attempt to free the returned string.</P
507
779
><P
510
782
CLASS="VARIABLELIST"
511
783
><DL
512
784
><DT
513
 
><EM
514
 
>Arguments</EM
515
 
></DT
 
785
>Arguments</DT
516
786
><DD
517
787
><P
518
 
><VAR
 
788
><TT
519
789
CLASS="LITERAL"
520
 
>Driver</VAR
 
790
>Driver</TT
521
791
>: The target driver.</P
522
792
></DD
523
793
><DT
524
 
><EM
525
 
>Returns</EM
526
 
></DT
 
794
>Returns</DT
527
795
><DD
528
796
><P
529
797
>A string containing the driver's description. It will be one or two short sentences with no newlines.</P
537
805
CLASS="SECTION"
538
806
><A
539
807
NAME="DBI-DRIVER-GET-MAINTAINER"
540
 
>3.2.6.4. dbi_driver_get_maintainer</A
 
808
>3.2.9.4. dbi_driver_get_maintainer</A
541
809
></H3
542
 
><P
543
 
><TABLE
544
 
BORDER="0"
545
 
BGCOLOR="#E0E0E0"
546
 
WIDTH="100%"
547
 
><TR
548
 
><TD
549
 
><FONT
550
 
COLOR="#000000"
551
 
><PRE
552
 
CLASS="PROGRAMLISTING"
553
 
>const char *dbi_driver_get_maintainer(dbi_driver Driver)</PRE
554
 
></FONT
555
 
></TD
556
 
></TR
557
 
></TABLE
558
 
></P
 
810
><DIV
 
811
CLASS="FUNCSYNOPSIS"
 
812
><P
 
813
></P
 
814
><A
 
815
NAME="AEN590"
 
816
></A
 
817
><P
 
818
><CODE
 
819
><CODE
 
820
CLASS="FUNCDEF"
 
821
>const char *<B
 
822
CLASS="FSFUNC"
 
823
>dbi_driver_get_maintainer</B
 
824
></CODE
 
825
>(dbi_driver <VAR
 
826
CLASS="PDPARAM"
 
827
>Driver</VAR
 
828
>);</CODE
 
829
></P
 
830
><P
 
831
></P
 
832
></DIV
559
833
><P
560
834
>Requests the maintainer of the specified driver. The calling program must not attempt to free the returned string.</P
561
835
><P
564
838
CLASS="VARIABLELIST"
565
839
><DL
566
840
><DT
567
 
><EM
568
 
>Arguments</EM
569
 
></DT
 
841
>Arguments</DT
570
842
><DD
571
843
><P
572
 
><VAR
 
844
><TT
573
845
CLASS="LITERAL"
574
 
>Driver</VAR
 
846
>Driver</TT
575
847
>: The target driver.</P
576
848
></DD
577
849
><DT
578
 
><EM
579
 
>Returns</EM
580
 
></DT
 
850
>Returns</DT
581
851
><DD
582
852
><P
583
853
>A string containing the driver maintainer's full name and email address.</P
591
861
CLASS="SECTION"
592
862
><A
593
863
NAME="DBI-DRIVER-GET-URL"
594
 
>3.2.6.5. dbi_driver_get_url</A
 
864
>3.2.9.5. dbi_driver_get_url</A
595
865
></H3
596
 
><P
597
 
><TABLE
598
 
BORDER="0"
599
 
BGCOLOR="#E0E0E0"
600
 
WIDTH="100%"
601
 
><TR
602
 
><TD
603
 
><FONT
604
 
COLOR="#000000"
605
 
><PRE
606
 
CLASS="PROGRAMLISTING"
607
 
>const char *dbi_driver_get_url(dbi_driver Driver)</PRE
608
 
></FONT
609
 
></TD
610
 
></TR
611
 
></TABLE
612
 
></P
 
866
><DIV
 
867
CLASS="FUNCSYNOPSIS"
 
868
><P
 
869
></P
 
870
><A
 
871
NAME="AEN609"
 
872
></A
 
873
><P
 
874
><CODE
 
875
><CODE
 
876
CLASS="FUNCDEF"
 
877
>const char *<B
 
878
CLASS="FSFUNC"
 
879
>dbi_driver_get_url</B
 
880
></CODE
 
881
>(dbi_driver <VAR
 
882
CLASS="PDPARAM"
 
883
>Driver</VAR
 
884
>);</CODE
 
885
></P
 
886
><P
 
887
></P
 
888
></DIV
613
889
><P
614
890
>Requests the maintainer's URL for the specified driver. This is useful for drivers maintained by a third party. The calling program must not attempt to free the returned string.</P
615
891
><P
618
894
CLASS="VARIABLELIST"
619
895
><DL
620
896
><DT
621
 
><EM
622
 
>Arguments</EM
623
 
></DT
 
897
>Arguments</DT
624
898
><DD
625
899
><P
626
 
><VAR
 
900
><TT
627
901
CLASS="LITERAL"
628
 
>Driver</VAR
 
902
>Driver</TT
629
903
>: The target driver.</P
630
904
></DD
631
905
></DL
637
911
CLASS="SECTION"
638
912
><A
639
913
NAME="DBI-DRIVER-GET-VERSION"
640
 
>3.2.6.6. dbi_driver_get_version</A
 
914
>3.2.9.6. dbi_driver_get_version</A
641
915
></H3
642
 
><P
643
 
><TABLE
644
 
BORDER="0"
645
 
BGCOLOR="#E0E0E0"
646
 
WIDTH="100%"
647
 
><TR
648
 
><TD
649
 
><FONT
650
 
COLOR="#000000"
651
 
><PRE
652
 
CLASS="PROGRAMLISTING"
653
 
>const char *dbi_driver_get_version(dbi_driver Driver)</PRE
654
 
></FONT
655
 
></TD
656
 
></TR
657
 
></TABLE
658
 
></P
 
916
><DIV
 
917
CLASS="FUNCSYNOPSIS"
 
918
><P
 
919
></P
 
920
><A
 
921
NAME="AEN624"
 
922
></A
 
923
><P
 
924
><CODE
 
925
><CODE
 
926
CLASS="FUNCDEF"
 
927
>const char *<B
 
928
CLASS="FSFUNC"
 
929
>dbi_driver_get_version</B
 
930
></CODE
 
931
>(<VAR
 
932
CLASS="PDPARAM"
 
933
>dbi_driver Driver</VAR
 
934
>);</CODE
 
935
></P
 
936
><P
 
937
></P
 
938
></DIV
659
939
><P
660
940
>Requests the version of the specified driver. The calling program must not attempt to free the returned string.</P
661
941
><P
664
944
CLASS="VARIABLELIST"
665
945
><DL
666
946
><DT
667
 
><EM
668
 
>Arguments</EM
669
 
></DT
 
947
>Arguments</DT
670
948
><DD
671
949
><P
672
 
><VAR
 
950
><TT
673
951
CLASS="LITERAL"
674
 
>Driver</VAR
 
952
>Driver</TT
675
953
>: The target driver.</P
676
954
></DD
677
955
><DT
678
 
><EM
679
 
>Returns</EM
680
 
></DT
 
956
>Returns</DT
681
957
><DD
682
958
><P
683
959
>A string containing the driver's version.</P
691
967
CLASS="SECTION"
692
968
><A
693
969
NAME="DBI-DRIVER-GET-DATE-COMPILED"
694
 
>3.2.6.7. dbi_driver_get_date_compiled</A
 
970
>3.2.9.7. dbi_driver_get_date_compiled</A
695
971
></H3
696
 
><P
697
 
><TABLE
698
 
BORDER="0"
699
 
BGCOLOR="#E0E0E0"
700
 
WIDTH="100%"
701
 
><TR
702
 
><TD
703
 
><FONT
704
 
COLOR="#000000"
705
 
><PRE
706
 
CLASS="PROGRAMLISTING"
707
 
>const char *dbi_driver_get_date_compiled(dbi_driver Driver)</PRE
708
 
></FONT
709
 
></TD
710
 
></TR
711
 
></TABLE
712
 
></P
 
972
><DIV
 
973
CLASS="FUNCSYNOPSIS"
 
974
><P
 
975
></P
 
976
><A
 
977
NAME="AEN643"
 
978
></A
 
979
><P
 
980
><CODE
 
981
><CODE
 
982
CLASS="FUNCDEF"
 
983
>const char *<B
 
984
CLASS="FSFUNC"
 
985
>dbi_driver_get_date_compiled</B
 
986
></CODE
 
987
>(dbi_driver <VAR
 
988
CLASS="PDPARAM"
 
989
>Driver</VAR
 
990
>);</CODE
 
991
></P
 
992
><P
 
993
></P
 
994
></DIV
713
995
><P
714
996
>Requests the compilation date of the specified driver. The calling program must not attempt to free the returned string.</P
715
997
><P
718
1000
CLASS="VARIABLELIST"
719
1001
><DL
720
1002
><DT
721
 
><EM
722
 
>Arguments</EM
723
 
></DT
 
1003
>Arguments</DT
724
1004
><DD
725
1005
><P
726
 
><VAR
 
1006
><TT
727
1007
CLASS="LITERAL"
728
 
>Driver</VAR
 
1008
>Driver</TT
729
1009
>: The target driver.</P
730
1010
></DD
731
1011
><DT
732
 
><EM
733
 
>Returns</EM
734
 
></DT
 
1012
>Returns</DT
735
1013
><DD
736
1014
><P
737
1015
>A string containing the date the driver was compiled.</P