Debian Codegraph @

doc/programmers-guide/reference-driver.html

raw
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2 <HTML
3 ><HEAD
4 ><TITLE
5 >Driver Infrastructure</TITLE
6 ><META
7 NAME="GENERATOR"
8 CONTENT="Modular DocBook HTML Stylesheet Version 1.79"><LINK
9 REL="HOME"
10 TITLE="Database Independent Abstraction Layer for C"
11 HREF="index.html"><LINK
12 REL="UP"
13 TITLE="libdbi API Reference"
14 HREF="reference.html"><LINK
15 REL="PREVIOUS"
16 TITLE="Instance Infrastructure"
17 HREF="reference-core.html"><LINK
18 REL="NEXT"
19 TITLE="Connection Infrastructure"
20 HREF="reference-conn.html"></HEAD
21 ><BODY
22 CLASS="SECTION"
23 BGCOLOR="#FFFFFF"
24 TEXT="#000000"
25 LINK="#0000FF"
26 VLINK="#840084"
27 ALINK="#0000FF"
28 ><DIV
29 CLASS="NAVHEADER"
30 ><TABLE
31 SUMMARY="Header navigation table"
32 WIDTH="100%"
33 BORDER="0"
34 CELLPADDING="0"
35 CELLSPACING="0"
36 ><TR
37 ><TH
38 COLSPAN="3"
39 ALIGN="center"
40 >Database Independent Abstraction Layer for C: libdbi Programmer's Guide</TH
41 ></TR
42 ><TR
43 ><TD
44 WIDTH="10%"
45 ALIGN="left"
46 VALIGN="bottom"
47 ><A
48 HREF="reference-core.html"
49 ACCESSKEY="P"
50 >Prev</A
51 ></TD
52 ><TD
53 WIDTH="80%"
54 ALIGN="center"
55 VALIGN="bottom"
56 >Chapter 7. libdbi API Reference</TD
57 ><TD
58 WIDTH="10%"
59 ALIGN="right"
60 VALIGN="bottom"
61 ><A
62 HREF="reference-conn.html"
63 ACCESSKEY="N"
64 >Next</A
65 ></TD
66 ></TR
67 ></TABLE
68 ><HR
69 ALIGN="LEFT"
70 WIDTH="100%"></DIV
71 ><DIV
72 CLASS="SECTION"
73 ><H1
74 CLASS="SECTION"
75 ><A
76 NAME="REFERENCE-DRIVER"
77 >7.2. Driver Infrastructure</A
78 ></H1
79 ><DIV
80 CLASS="SECTION"
81 ><H2
82 CLASS="SECTION"
83 ><A
84 NAME="DBI-DRIVER-LIST-R"
85 >7.2.1. dbi_driver_list_r</A
86 ></H2
87 ><DIV
88 CLASS="FUNCSYNOPSIS"
89 ><P
90 ></P
91 ><A
92 NAME="AEN671"
93 ></A
94 ><P
95 ><CODE
96 ><CODE
97 CLASS="FUNCDEF"
98 >dbi_driver <B
99 CLASS="FSFUNC"
100 >dbi_driver_list_r</B
101 ></CODE
102 >(dbi_driver <VAR
103 CLASS="PDPARAM"
104 >Current</VAR
105 >, dbi_inst <VAR
106 CLASS="PDPARAM"
107 >Inst</VAR
108 >);</CODE
109 ></P
110 ><P
111 ></P
112 ></DIV
113 ><P
114 >Enumerates all loaded drivers of the given instance. 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
115 ><P
116 ></P
117 ><DIV
118 CLASS="VARIABLELIST"
119 ><DL
120 ><DT
121 >Arguments</DT
122 ><DD
123 ><P
124 ><TT
125 CLASS="LITERAL"
126 >Current</TT
127 >: The current driver in the list of drivers, or NULL to retrieve the first one.</P
128 ><P
129 ><TT
130 CLASS="LITERAL"
131 >Inst</TT
132 >: The instance handle.</P
133 ></DD
134 ><DT
135 >Returns</DT
136 ><DD
137 ><P
138 >The next available driver, or NULL if there is an error or no more are available.</P
139 ></DD
140 ><DT
141 >Availability</DT
142 ><DD
143 ><P
144 >0.9.0</P
145 ></DD
146 ></DL
147 ></DIV
148 ></DIV
149 ><DIV
150 CLASS="SECTION"
151 ><H2
152 CLASS="SECTION"
153 ><A
154 NAME="DBI-DRIVER-LIST"
155 >7.2.2. dbi_driver_list</A
156 ></H2
157 ><DIV
158 CLASS="FUNCSYNOPSIS"
159 ><P
160 ></P
161 ><A
162 NAME="AEN698"
163 ></A
164 ><P
165 ><CODE
166 ><CODE
167 CLASS="FUNCDEF"
168 >dbi_driver <B
169 CLASS="FSFUNC"
170 >dbi_driver_list</B
171 ></CODE
172 >(dbi_driver <VAR
173 CLASS="PDPARAM"
174 >Current</VAR
175 >);</CODE
176 ></P
177 ><P
178 ></P
179 ></DIV
180 ><P
181 >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
182 ><DIV
183 CLASS="NOTE"
184 ><BLOCKQUOTE
185 CLASS="NOTE"
186 ><P
187 ><B
188 >Note: </B
189 >This function is deprecated. Use <A
190 HREF="reference-driver.html#DBI-DRIVER-LIST-R"
191 >dbi_driver_list_r</A
192 > instead.</P
193 ></BLOCKQUOTE
194 ></DIV
195 ><P
196 ></P
197 ><DIV
198 CLASS="VARIABLELIST"
199 ><DL
200 ><DT
201 >Arguments</DT
202 ><DD
203 ><P
204 ><TT
205 CLASS="LITERAL"
206 >Current</TT
207 >: The current driver in the list of drivers, or NULL to retrieve the first one.</P
208 ></DD
209 ><DT
210 >Returns</DT
211 ><DD
212 ><P
213 >The next available driver, or NULL if there is an error or no more are available.</P
214 ></DD
215 ></DL
216 ></DIV
217 ></DIV
218 ><DIV
219 CLASS="SECTION"
220 ><H2
221 CLASS="SECTION"
222 ><A
223 NAME="DBI-DRIVER-OPEN-R"
224 >7.2.3. dbi_driver_open_r</A
225 ></H2
226 ><DIV
227 CLASS="FUNCSYNOPSIS"
228 ><P
229 ></P
230 ><A
231 NAME="AEN720"
232 ></A
233 ><P
234 ><CODE
235 ><CODE
236 CLASS="FUNCDEF"
237 >dbi_driver <B
238 CLASS="FSFUNC"
239 >dbi_driver_open_r</B
240 ></CODE
241 >(const char *<VAR
242 CLASS="PDPARAM"
243 >name</VAR
244 >, dbi_inst <VAR
245 CLASS="PDPARAM"
246 >Inst</VAR
247 >);</CODE
248 ></P
249 ><P
250 ></P
251 ></DIV
252 ><P
253 >Locate the driver with the specified name.</P
254 ><P
255 ></P
256 ><DIV
257 CLASS="VARIABLELIST"
258 ><DL
259 ><DT
260 >Arguments</DT
261 ><DD
262 ><P
263 ><TT
264 CLASS="LITERAL"
265 >name</TT
266 >: The name of the driver to open.</P
267 ><P
268 ><TT
269 CLASS="LITERAL"
270 >Inst</TT
271 >: The instance handle.</P
272 ></DD
273 ><DT
274 >Returns</DT
275 ><DD
276 ><P
277 >The requested driver, or NULL if there is no such driver.</P
278 ></DD
279 ><DT
280 >Availability</DT
281 ><DD
282 ><P
283 >0.9.0</P
284 ></DD
285 ></DL
286 ></DIV
287 ></DIV
288 ><DIV
289 CLASS="SECTION"
290 ><H2
291 CLASS="SECTION"
292 ><A
293 NAME="DBI-DRIVER-OPEN"
294 >7.2.4. dbi_driver_open</A
295 ></H2
296 ><DIV
297 CLASS="FUNCSYNOPSIS"
298 ><P
299 ></P
300 ><A
301 NAME="AEN747"
302 ></A
303 ><P
304 ><CODE
305 ><CODE
306 CLASS="FUNCDEF"
307 >dbi_driver <B
308 CLASS="FSFUNC"
309 >dbi_driver_open</B
310 ></CODE
311 >(const char *<VAR
312 CLASS="PDPARAM"
313 >name</VAR
314 >);</CODE
315 ></P
316 ><P
317 ></P
318 ></DIV
319 ><P
320 >Locate the driver with the specified name.</P
321 ><DIV
322 CLASS="NOTE"
323 ><BLOCKQUOTE
324 CLASS="NOTE"
325 ><P
326 ><B
327 >Note: </B
328 >This function is deprecated. Use <A
329 HREF="reference-driver.html#DBI-DRIVER-OPEN-R"
330 >dbi_driver_open_r</A
331 > instead.</P
332 ></BLOCKQUOTE
333 ></DIV
334 ><P
335 ></P
336 ><DIV
337 CLASS="VARIABLELIST"
338 ><DL
339 ><DT
340 >Arguments</DT
341 ><DD
342 ><P
343 ><TT
344 CLASS="LITERAL"
345 >name</TT
346 >: The name of the driver to open.</P
347 ></DD
348 ><DT
349 >Returns</DT
350 ><DD
351 ><P
352 >The requested driver, or NULL if there is no such driver.</P
353 ></DD
354 ></DL
355 ></DIV
356 ></DIV
357 ><DIV
358 CLASS="SECTION"
359 ><H2
360 CLASS="SECTION"
361 ><A
362 NAME="DBI-DRIVER-GET-INSTANCE"
363 >7.2.5. dbi_driver_get_instance</A
364 ></H2
365 ><DIV
366 CLASS="FUNCSYNOPSIS"
367 ><P
368 ></P
369 ><A
370 NAME="AEN769"
371 ></A
372 ><P
373 ><CODE
374 ><CODE
375 CLASS="FUNCDEF"
376 >int <B
377 CLASS="FSFUNC"
378 >dbi_driver_get_instance</B
379 ></CODE
380 >(dbi_driver <VAR
381 CLASS="PDPARAM"
382 >Driver</VAR
383 >);</CODE
384 ></P
385 ><P
386 ></P
387 ></DIV
388 ><P
389 >Retrieves the handle of the instance that loaded the driver.</P
390 ><P
391 ></P
392 ><DIV
393 CLASS="VARIABLELIST"
394 ><DL
395 ><DT
396 >Arguments</DT
397 ><DD
398 ><P
399 ><TT
400 CLASS="LITERAL"
401 >Driver</TT
402 >: The target driver.</P
403 ></DD
404 ><DT
405 >Returns</DT
406 ><DD
407 ><P
408 >The instance handle, or NULL in case of an error.</P
409 ></DD
410 ><DT
411 >Availability</DT
412 ><DD
413 ><P
414 >0.9.0</P
415 ></DD
416 ></DL
417 ></DIV
418 ></DIV
419 ><DIV
420 CLASS="SECTION"
421 ><H2
422 CLASS="SECTION"
423 ><A
424 NAME="DBI-DRIVER-IS-RESERVED-WORD"
425 >7.2.6. dbi_driver_is_reserved_word</A
426 ></H2
427 ><DIV
428 CLASS="FUNCSYNOPSIS"
429 ><P
430 ></P
431 ><A
432 NAME="AEN792"
433 ></A
434 ><P
435 ><CODE
436 ><CODE
437 CLASS="FUNCDEF"
438 >int <B
439 CLASS="FSFUNC"
440 >dbi_driver_is_reserved_word</B
441 ></CODE
442 >(dbi_driver <VAR
443 CLASS="PDPARAM"
444 >Driver</VAR
445 >, const char *<VAR
446 CLASS="PDPARAM"
447 >word</VAR
448 >);</CODE
449 ></P
450 ><P
451 ></P
452 ></DIV
453 ><P
454 >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
455 ><P
456 ></P
457 ><DIV
458 CLASS="VARIABLELIST"
459 ><DL
460 ><DT
461 >Arguments</DT
462 ><DD
463 ><P
464 ><TT
465 CLASS="LITERAL"
466 >Driver</TT
467 >: The target driver.</P
468 ><P
469 ><TT
470 CLASS="LITERAL"
471 >word</TT
472 >: The word to check against the reserved word list.</P
473 ></DD
474 ><DT
475 >Returns</DT
476 ><DD
477 ><P
478 >-1 if an error occurs, 0 if the word is not reserved, 1 otherwise.</P
479 ></DD
480 ></DL
481 ></DIV
482 ></DIV
483 ><DIV
484 CLASS="SECTION"
485 ><H2
486 CLASS="SECTION"
487 ><A
488 NAME="DBI-DRIVER-SPECIFIC-FUNCTION"
489 >7.2.7. dbi_driver_specific_function</A
490 ></H2
491 ><DIV
492 CLASS="FUNCSYNOPSIS"
493 ><P
494 ></P
495 ><A
496 NAME="AEN815"
497 ></A
498 ><P
499 ><CODE
500 ><CODE
501 CLASS="FUNCDEF"
502 >void *<B
503 CLASS="FSFUNC"
504 >dbi_driver_specific_function</B
505 ></CODE
506 >(dbi_driver <VAR
507 CLASS="PDPARAM"
508 >Driver</VAR
509 >, const char *<VAR
510 CLASS="PDPARAM"
511 >name</VAR
512 >);</CODE
513 ></P
514 ><P
515 ></P
516 ></DIV
517 ><P
518 >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
519 ><P
520 ></P
521 ><DIV
522 CLASS="VARIABLELIST"
523 ><DL
524 ><DT
525 >Arguments</DT
526 ><DD
527 ><P
528 ><TT
529 CLASS="LITERAL"
530 >Driver</TT
531 >: The target driver.</P
532 ><P
533 ><TT
534 CLASS="LITERAL"
535 >name</TT
536 >: The name of the custom function.</P
537 ></DD
538 ><DT
539 >Returns</DT
540 ><DD
541 ><P
542 >If the custom function is found, a pointer to that function. If not, returns NULL.</P
543 ></DD
544 ><DT
545 >Availability</DT
546 ><DD
547 ><P
548 >0.9.0</P
549 ></DD
550 ></DL
551 ></DIV
552 ></DIV
553 ><DIV
554 CLASS="SECTION"
555 ><H2
556 CLASS="SECTION"
557 ><A
558 NAME="DBI-DRIVER-QUOTE-STRING"
559 >7.2.8. dbi_driver_quote_string</A
560 ></H2
561 ><DIV
562 CLASS="FUNCSYNOPSIS"
563 ><P
564 ></P
565 ><A
566 NAME="AEN842"
567 ></A
568 ><P
569 ><CODE
570 ><CODE
571 CLASS="FUNCDEF"
572 >int <B
573 CLASS="FSFUNC"
574 >dbi_driver_quote_string</B
575 ></CODE
576 >(dbi_driver <VAR
577 CLASS="PDPARAM"
578 >Driver</VAR
579 >, <VAR
580 CLASS="PDPARAM"
581 >char **orig</VAR
582 >);</CODE
583 ></P
584 ><P
585 ></P
586 ></DIV
587 ><P
588 >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
589 CLASS="PARAMETER"
590 >orig</CODE
591 > 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
592 ><DIV
593 CLASS="NOTE"
594 ><BLOCKQUOTE
595 CLASS="NOTE"
596 ><P
597 ><B
598 >Note: </B
599 >This function is deprecated. Use <A
600 HREF="reference-query.html#DBI-CONN-QUOTE-STRING"
601 >dbi_conn_quote_string</A
602 > instead.</P
603 ></BLOCKQUOTE
604 ></DIV
605 ><P
606 ></P
607 ><DIV
608 CLASS="VARIABLELIST"
609 ><DL
610 ><DT
611 >Arguments</DT
612 ><DD
613 ><P
614 ><TT
615 CLASS="LITERAL"
616 >Driver</TT
617 >: The target driver.</P
618 ><P
619 ><TT
620 CLASS="LITERAL"
621 >orig</TT
622 >: A pointer to the string to quote and escape.</P
623 ></DD
624 ><DT
625 >Returns</DT
626 ><DD
627 ><P
628 >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
629 ></DD
630 ></DL
631 ></DIV
632 ></DIV
633 ><DIV
634 CLASS="SECTION"
635 ><H2
636 CLASS="SECTION"
637 ><A
638 NAME="DBI-DRIVER-QUOTE-STRING-COPY"
639 >7.2.9. dbi_driver_quote_string_copy</A
640 ></H2
641 ><DIV
642 CLASS="FUNCSYNOPSIS"
643 ><P
644 ></P
645 ><A
646 NAME="AEN869"
647 ></A
648 ><P
649 ><CODE
650 ><CODE
651 CLASS="FUNCDEF"
652 >int <B
653 CLASS="FSFUNC"
654 >dbi_driver_quote_string_copy</B
655 ></CODE
656 >(dbi_driver <VAR
657 CLASS="PDPARAM"
658 >Driver</VAR
659 >, char **<VAR
660 CLASS="PDPARAM"
661 >orig</VAR
662 >, char **<VAR
663 CLASS="PDPARAM"
664 >newstr</VAR
665 >);</CODE
666 ></P
667 ><P
668 ></P
669 ></DIV
670 ><P
671 >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
672 CLASS="PARAMETER"
673 >newstr</CODE
674 > 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
675 CLASS="PARAMETER"
676 >newstr</CODE
677 > is an invalid pointer which you must not attempt to deallocate.</P
678 ><DIV
679 CLASS="NOTE"
680 ><BLOCKQUOTE
681 CLASS="NOTE"
682 ><P
683 ><B
684 >Note: </B
685 >This function is deprecated. Use <A
686 HREF="reference-query.html#DBI-CONN-QUOTE-STRING-COPY"
687 >dbi_conn_quote_string_copy</A
688 > instead.</P
689 ></BLOCKQUOTE
690 ></DIV
691 ><P
692 ></P
693 ><DIV
694 CLASS="VARIABLELIST"
695 ><DL
696 ><DT
697 >Arguments</DT
698 ><DD
699 ><P
700 ><TT
701 CLASS="LITERAL"
702 >Driver</TT
703 >: The target driver.</P
704 ><P
705 ><TT
706 CLASS="LITERAL"
707 >orig</TT
708 >: A pointer to the string to quote and escape.</P
709 ><P
710 ><TT
711 CLASS="LITERAL"
712 >newstr</TT
713 >: After the function returns, this pointer will point to the quoted and escaped string.</P
714 ></DD
715 ><DT
716 >Returns</DT
717 ><DD
718 ><P
719 >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
720 ></DD
721 ></DL
722 ></DIV
723 ></DIV
724 ><DIV
725 CLASS="SECTION"
726 ><H2
727 CLASS="SECTION"
728 ><A
729 NAME="DBI-DRIVER-ENCODING-FROM-IANA"
730 >7.2.10. dbi_driver_encoding_from_iana</A
731 ></H2
732 ><DIV
733 CLASS="FUNCSYNOPSIS"
734 ><P
735 ></P
736 ><A
737 NAME="AEN901"
738 ></A
739 ><P
740 ><CODE
741 ><CODE
742 CLASS="FUNCDEF"
743 >const char *<B
744 CLASS="FSFUNC"
745 >dbi_driver_encoding_from_iana</B
746 ></CODE
747 >(dbi_driver <VAR
748 CLASS="PDPARAM"
749 >Driver</VAR
750 >, const char *<VAR
751 CLASS="PDPARAM"
752 >iana_encoding</VAR
753 >);</CODE
754 ></P
755 ><P
756 ></P
757 ></DIV
758 ><P
759 >Requests the database engine specific name of the character encoding identified by its name as known to <A
760 HREF="http://www.iana.org"
761 TARGET="_top"
762 >IANA</A
763 >. Use this function to pass the database engine specific encoding name to SQL queries , e.g. as part of a <B
764 CLASS="COMMAND"
765 >CREATE DATABASE</B
766 > command.</P
767 ><P
768 ></P
769 ><DIV
770 CLASS="VARIABLELIST"
771 ><DL
772 ><DT
773 >Arguments</DT
774 ><DD
775 ><P
776 ><TT
777 CLASS="LITERAL"
778 >Driver</TT
779 >: The target driver.</P
780 ><P
781 ><TT
782 CLASS="LITERAL"
783 >iana_encoding</TT
784 >: The IANA name of the character encoding.</P
785 ></DD
786 ><DT
787 >Returns</DT
788 ><DD
789 ><P
790 >A string containing the database engine specific encoding name. If the encoding name cannot be translated, the IANA name is returned without translation.</P
791 ></DD
792 ><DT
793 >Availability</DT
794 ><DD
795 ><P
796 >0.8.0</P
797 ></DD
798 ></DL
799 ></DIV
800 ></DIV
801 ><DIV
802 CLASS="SECTION"
803 ><H2
804 CLASS="SECTION"
805 ><A
806 NAME="DBI-DRIVER-ENCODING-TO-IANA"
807 >7.2.11. dbi_driver_encoding_to_iana</A
808 ></H2
809 ><DIV
810 CLASS="FUNCSYNOPSIS"
811 ><P
812 ></P
813 ><A
814 NAME="AEN930"
815 ></A
816 ><P
817 ><CODE
818 ><CODE
819 CLASS="FUNCDEF"
820 >const char *<B
821 CLASS="FSFUNC"
822 >dbi_driver_encoding_to_iana</B
823 ></CODE
824 >(dbi_driver <VAR
825 CLASS="PDPARAM"
826 >Driver</VAR
827 >, const char *<VAR
828 CLASS="PDPARAM"
829 >db_encoding</VAR
830 >);</CODE
831 ></P
832 ><P
833 ></P
834 ></DIV
835 ><P
836 >Requests the <A
837 HREF="http://www.iana.org"
838 TARGET="_top"
839 >IANA</A
840 > 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
841 ><P
842 ></P
843 ><DIV
844 CLASS="VARIABLELIST"
845 ><DL
846 ><DT
847 >Arguments</DT
848 ><DD
849 ><P
850 ><TT
851 CLASS="LITERAL"
852 >Driver</TT
853 >: The target driver.</P
854 ><P
855 ><TT
856 CLASS="LITERAL"
857 >db_encoding</TT
858 >: The database engine specific name of the character encoding.</P
859 ></DD
860 ><DT
861 >Returns</DT
862 ><DD
863 ><P
864 >A string containing the IANA encoding name. If the encoding name cannot be translated, the database engine specific name is returned without translation.</P
865 ></DD
866 ><DT
867 >Availability</DT
868 ><DD
869 ><P
870 >0.8.0</P
871 ></DD
872 ></DL
873 ></DIV
874 ></DIV
875 ><DIV
876 CLASS="SECTION"
877 ><H2
878 CLASS="SECTION"
879 ><A
880 NAME="REFERENCE-DRIVER-INFO"
881 >7.2.12. Driver Information</A
882 ></H2
883 ><DIV
884 CLASS="SECTION"
885 ><H3
886 CLASS="SECTION"
887 ><A
888 NAME="DBI-DRIVER-GET-NAME"
889 >7.2.12.1. dbi_driver_get_name</A
890 ></H3
891 ><DIV
892 CLASS="FUNCSYNOPSIS"
893 ><P
894 ></P
895 ><A
896 NAME="AEN960"
897 ></A
898 ><P
899 ><CODE
900 ><CODE
901 CLASS="FUNCDEF"
902 >const char *<B
903 CLASS="FSFUNC"
904 >dbi_driver_get_name</B
905 ></CODE
906 >(dbi_driver <VAR
907 CLASS="PDPARAM"
908 >Driver</VAR
909 >);</CODE
910 ></P
911 ><P
912 ></P
913 ></DIV
914 ><P
915 >Requests the name of the specified driver. The calling program must not attempt to free the returned string.</P
916 ><P
917 ></P
918 ><DIV
919 CLASS="VARIABLELIST"
920 ><DL
921 ><DT
922 >Arguments</DT
923 ><DD
924 ><P
925 ><TT
926 CLASS="LITERAL"
927 >Driver</TT
928 >: The target driver.</P
929 ></DD
930 ><DT
931 >Returns</DT
932 ><DD
933 ><P
934 >A string containing the driver's name.</P
935 ></DD
936 ></DL
937 ></DIV
938 ></DIV
939 ><DIV
940 CLASS="SECTION"
941 ><H3
942 CLASS="SECTION"
943 ><A
944 NAME="DBI-DRIVER-GET-FILENAME"
945 >7.2.12.2. dbi_driver_get_filename</A
946 ></H3
947 ><DIV
948 CLASS="FUNCSYNOPSIS"
949 ><P
950 ></P
951 ><A
952 NAME="AEN979"
953 ></A
954 ><P
955 ><CODE
956 ><CODE
957 CLASS="FUNCDEF"
958 >const char *<B
959 CLASS="FSFUNC"
960 >dbi_driver_get_filename</B
961 ></CODE
962 >(dbi_driver <VAR
963 CLASS="PDPARAM"
964 >Driver</VAR
965 >);</CODE
966 ></P
967 ><P
968 ></P
969 ></DIV
970 ><P
971 >Requests the filename of the specified driver. The calling program must not attempt to free the returned string.</P
972 ><P
973 ></P
974 ><DIV
975 CLASS="VARIABLELIST"
976 ><DL
977 ><DT
978 >Arguments</DT
979 ><DD
980 ><P
981 ><TT
982 CLASS="LITERAL"
983 >Driver</TT
984 >: The target driver.</P
985 ></DD
986 ><DT
987 >Returns</DT
988 ><DD
989 ><P
990 >A string containing the driver's full path and file name.</P
991 ></DD
992 ></DL
993 ></DIV
994 ></DIV
995 ><DIV
996 CLASS="SECTION"
997 ><H3
998 CLASS="SECTION"
999 ><A
1000 NAME="DBI-DRIVER-GET-DESCRIPTION"
1001 >7.2.12.3. dbi_driver_get_description</A
1002 ></H3
1003 ><DIV
1004 CLASS="FUNCSYNOPSIS"
1005 ><P
1006 ></P
1007 ><A
1008 NAME="AEN998"
1009 ></A
1010 ><P
1011 ><CODE
1012 ><CODE
1013 CLASS="FUNCDEF"
1014 >const char *<B
1015 CLASS="FSFUNC"
1016 >dbi_driver_get_description</B
1017 ></CODE
1018 >(dbi_driver Driver);</CODE
1019 ></P
1020 ><P
1021 ></P
1022 ></DIV
1023 ><P
1024 >Requests a description of the specified driver. The calling program must not attempt to free the returned string.</P
1025 ><P
1026 ></P
1027 ><DIV
1028 CLASS="VARIABLELIST"
1029 ><DL
1030 ><DT
1031 >Arguments</DT
1032 ><DD
1033 ><P
1034 ><TT
1035 CLASS="LITERAL"
1036 >Driver</TT
1037 >: The target driver.</P
1038 ></DD
1039 ><DT
1040 >Returns</DT
1041 ><DD
1042 ><P
1043 >A string containing the driver's description. It will be one or two short sentences with no newlines.</P
1044 ></DD
1045 ></DL
1046 ></DIV
1047 ></DIV
1048 ><DIV
1049 CLASS="SECTION"
1050 ><H3
1051 CLASS="SECTION"
1052 ><A
1053 NAME="DBI-DRIVER-GET-MAINTAINER"
1054 >7.2.12.4. dbi_driver_get_maintainer</A
1055 ></H3
1056 ><DIV
1057 CLASS="FUNCSYNOPSIS"
1058 ><P
1059 ></P
1060 ><A
1061 NAME="AEN1016"
1062 ></A
1063 ><P
1064 ><CODE
1065 ><CODE
1066 CLASS="FUNCDEF"
1067 >const char *<B
1068 CLASS="FSFUNC"
1069 >dbi_driver_get_maintainer</B
1070 ></CODE
1071 >(dbi_driver <VAR
1072 CLASS="PDPARAM"
1073 >Driver</VAR
1074 >);</CODE
1075 ></P
1076 ><P
1077 ></P
1078 ></DIV
1079 ><P
1080 >Requests the maintainer of the specified driver. The calling program must not attempt to free the returned string.</P
1081 ><P
1082 ></P
1083 ><DIV
1084 CLASS="VARIABLELIST"
1085 ><DL
1086 ><DT
1087 >Arguments</DT
1088 ><DD
1089 ><P
1090 ><TT
1091 CLASS="LITERAL"
1092 >Driver</TT
1093 >: The target driver.</P
1094 ></DD
1095 ><DT
1096 >Returns</DT
1097 ><DD
1098 ><P
1099 >A string containing the driver maintainer's full name and email address.</P
1100 ></DD
1101 ></DL
1102 ></DIV
1103 ></DIV
1104 ><DIV
1105 CLASS="SECTION"
1106 ><H3
1107 CLASS="SECTION"
1108 ><A
1109 NAME="DBI-DRIVER-GET-URL"
1110 >7.2.12.5. dbi_driver_get_url</A
1111 ></H3
1112 ><DIV
1113 CLASS="FUNCSYNOPSIS"
1114 ><P
1115 ></P
1116 ><A
1117 NAME="AEN1035"
1118 ></A
1119 ><P
1120 ><CODE
1121 ><CODE
1122 CLASS="FUNCDEF"
1123 >const char *<B
1124 CLASS="FSFUNC"
1125 >dbi_driver_get_url</B
1126 ></CODE
1127 >(dbi_driver <VAR
1128 CLASS="PDPARAM"
1129 >Driver</VAR
1130 >);</CODE
1131 ></P
1132 ><P
1133 ></P
1134 ></DIV
1135 ><P
1136 >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
1137 ><P
1138 ></P
1139 ><DIV
1140 CLASS="VARIABLELIST"
1141 ><DL
1142 ><DT
1143 >Arguments</DT
1144 ><DD
1145 ><P
1146 ><TT
1147 CLASS="LITERAL"
1148 >Driver</TT
1149 >: The target driver.</P
1150 ></DD
1151 ></DL
1152 ></DIV
1153 ></DIV
1154 ><DIV
1155 CLASS="SECTION"
1156 ><H3
1157 CLASS="SECTION"
1158 ><A
1159 NAME="DBI-DRIVER-GET-VERSION"
1160 >7.2.12.6. dbi_driver_get_version</A
1161 ></H3
1162 ><DIV
1163 CLASS="FUNCSYNOPSIS"
1164 ><P
1165 ></P
1166 ><A
1167 NAME="AEN1050"
1168 ></A
1169 ><P
1170 ><CODE
1171 ><CODE
1172 CLASS="FUNCDEF"
1173 >const char *<B
1174 CLASS="FSFUNC"
1175 >dbi_driver_get_version</B
1176 ></CODE
1177 >(<VAR
1178 CLASS="PDPARAM"
1179 >dbi_driver Driver</VAR
1180 >);</CODE
1181 ></P
1182 ><P
1183 ></P
1184 ></DIV
1185 ><P
1186 >Requests the version of the specified driver. The calling program must not attempt to free the returned string.</P
1187 ><P
1188 ></P
1189 ><DIV
1190 CLASS="VARIABLELIST"
1191 ><DL
1192 ><DT
1193 >Arguments</DT
1194 ><DD
1195 ><P
1196 ><TT
1197 CLASS="LITERAL"
1198 >Driver</TT
1199 >: The target driver.</P
1200 ></DD
1201 ><DT
1202 >Returns</DT
1203 ><DD
1204 ><P
1205 >A string containing the driver's version.</P
1206 ></DD
1207 ></DL
1208 ></DIV
1209 ></DIV
1210 ><DIV
1211 CLASS="SECTION"
1212 ><H3
1213 CLASS="SECTION"
1214 ><A
1215 NAME="DBI-DRIVER-GET-DATE-COMPILED"
1216 >7.2.12.7. dbi_driver_get_date_compiled</A
1217 ></H3
1218 ><DIV
1219 CLASS="FUNCSYNOPSIS"
1220 ><P
1221 ></P
1222 ><A
1223 NAME="AEN1069"
1224 ></A
1225 ><P
1226 ><CODE
1227 ><CODE
1228 CLASS="FUNCDEF"
1229 >const char *<B
1230 CLASS="FSFUNC"
1231 >dbi_driver_get_date_compiled</B
1232 ></CODE
1233 >(dbi_driver <VAR
1234 CLASS="PDPARAM"
1235 >Driver</VAR
1236 >);</CODE
1237 ></P
1238 ><P
1239 ></P
1240 ></DIV
1241 ><P
1242 >Requests the compilation date of the specified driver. The calling program must not attempt to free the returned string.</P
1243 ><P
1244 ></P
1245 ><DIV
1246 CLASS="VARIABLELIST"
1247 ><DL
1248 ><DT
1249 >Arguments</DT
1250 ><DD
1251 ><P
1252 ><TT
1253 CLASS="LITERAL"
1254 >Driver</TT
1255 >: The target driver.</P
1256 ></DD
1257 ><DT
1258 >Returns</DT
1259 ><DD
1260 ><P
1261 >A string containing the date the driver was compiled.</P
1262 ></DD
1263 ></DL
1264 ></DIV
1265 ></DIV
1266 ><DIV
1267 CLASS="SECTION"
1268 ><H3
1269 CLASS="SECTION"
1270 ><A
1271 NAME="DBI-DRIVER-CAP-GET"
1272 >7.2.12.8. dbi_driver_cap_get</A
1273 ></H3
1274 ><DIV
1275 CLASS="FUNCSYNOPSIS"
1276 ><P
1277 ></P
1278 ><A
1279 NAME="AEN1088"
1280 ></A
1281 ><P
1282 ><CODE
1283 ><CODE
1284 CLASS="FUNCDEF"
1285 >int <B
1286 CLASS="FSFUNC"
1287 >dbi_driver_cap_get</B
1288 ></CODE
1289 >(dbi_driver <VAR
1290 CLASS="PDPARAM"
1291 >Driver</VAR
1292 >, const char *<VAR
1293 CLASS="PDPARAM"
1294 >capname</VAR
1295 >);</CODE
1296 ></P
1297 ><P
1298 ></P
1299 ></DIV
1300 ><P
1301 >Requests the value of the driver capability which is specified as an argument.</P
1302 ><P
1303 ></P
1304 ><DIV
1305 CLASS="VARIABLELIST"
1306 ><DL
1307 ><DT
1308 >Arguments</DT
1309 ><DD
1310 ><P
1311 ><TT
1312 CLASS="LITERAL"
1313 >Driver</TT
1314 >: The target driver.</P
1315 ><P
1316 ><TT
1317 CLASS="LITERAL"
1318 >capname</TT
1319 >: A pointer to a string containing the name of the driver capability to be queried.</P
1320 ></DD
1321 ><DT
1322 >Returns</DT
1323 ><DD
1324 ><P
1325 >The numeric value of the driver capability.</P
1326 ></DD
1327 ></DL
1328 ></DIV
1329 ></DIV
1330 ></DIV
1331 ></DIV
1332 ><DIV
1333 CLASS="NAVFOOTER"
1334 ><HR
1335 ALIGN="LEFT"
1336 WIDTH="100%"><TABLE
1337 SUMMARY="Footer navigation table"
1338 WIDTH="100%"
1339 BORDER="0"
1340 CELLPADDING="0"
1341 CELLSPACING="0"
1342 ><TR
1343 ><TD
1344 WIDTH="33%"
1345 ALIGN="left"
1346 VALIGN="top"
1347 ><A
1348 HREF="reference-core.html"
1349 ACCESSKEY="P"
1350 >Prev</A
1351 ></TD
1352 ><TD
1353 WIDTH="34%"
1354 ALIGN="center"
1355 VALIGN="top"
1356 ><A
1357 HREF="index.html"
1358 ACCESSKEY="H"
1359 >Home</A
1360 ></TD
1361 ><TD
1362 WIDTH="33%"
1363 ALIGN="right"
1364 VALIGN="top"
1365 ><A
1366 HREF="reference-conn.html"
1367 ACCESSKEY="N"
1368 >Next</A
1369 ></TD
1370 ></TR
1371 ><TR
1372 ><TD
1373 WIDTH="33%"
1374 ALIGN="left"
1375 VALIGN="top"
1376 >Instance Infrastructure</TD
1377 ><TD
1378 WIDTH="34%"
1379 ALIGN="center"
1380 VALIGN="top"
1381 ><A
1382 HREF="reference.html"
1383 ACCESSKEY="U"
1384 >Up</A
1385 ></TD
1386 ><TD
1387 WIDTH="33%"
1388 ALIGN="right"
1389 VALIGN="top"
1390 >Connection Infrastructure</TD
1391 ></TR
1392 ></TABLE
1393 ></DIV
1394 ></BODY
1395 ></HTML
1396 >