← Back to branch summary

~ubuntu-branches/ubuntu/trusty/libdbi/trusty

« back to all changes in this revision

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

  • Committer: Package Import Robot
  • Author(s): Laszlo Boszormenyi (GCS), Laszlo Boszormenyi (GCS), Prach Pongpanich
  • Date: 2014-01-20 21:19:50 UTC
  • mfrom: (3.1.9 sid)
  • Revision ID: package-import@ubuntu.com-20140120211950-zyd6ykii7rd4vm7x
Tags: 0.9.0-1
http://bugs.debian.org/708115
http://bugs.debian.org/717437
http://bugs.debian.org/565558
http://bugs.debian.org/635659
[ Laszlo Boszormenyi (GCS) ]
* Correct debian/copyright .

[ Prach Pongpanich ]
* Imported Upstream version 0.9.0 (Closes: #708115, #717437)
* Use debhelper short rules with autoreconf (Closes: #565558)
* Add -dbg package
* Update symbols file for new symbols
* Add multiarch support
* Bump Standards-Version to 3.9.5
* Change Vcs fields to point to collab-maint
* Adopt package (Closes: #635659)

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/programmers-guide/reference-driver.html
13
13
TITLE="libdbi API Reference"
14
14
HREF="reference.html"><LINK
15
15
REL="PREVIOUS"
16
 
TITLE="Core Library Functions"
 
16
TITLE="Instance Infrastructure"
17
17
HREF="reference-core.html"><LINK
18
18
REL="NEXT"
19
19
TITLE="Connection Infrastructure"
53
53
WIDTH="80%"
54
54
ALIGN="center"
55
55
VALIGN="bottom"
56
 
>Chapter 4. libdbi API Reference</TD
 
56
>Chapter 7. libdbi API Reference</TD
57
57
><TD
58
58
WIDTH="10%"
59
59
ALIGN="right"
74
74
CLASS="SECTION"
75
75
><A
76
76
NAME="REFERENCE-DRIVER"
77
 
>4.2. Driver Infrastructure</A
 
77
>7.2. Driver Infrastructure</A
78
78
></H1
79
79
><DIV
80
80
CLASS="SECTION"
81
81
><H2
82
82
CLASS="SECTION"
83
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
84
154
NAME="DBI-DRIVER-LIST"
85
 
>4.2.1. dbi_driver_list</A
 
155
>7.2.2. dbi_driver_list</A
86
156
></H2
87
157
><DIV
88
158
CLASS="FUNCSYNOPSIS"
89
159
><P
90
160
></P
91
161
><A
92
 
NAME="AEN418"
 
162
NAME="AEN698"
93
163
></A
94
164
><P
95
165
><CODE
109
179
></DIV
110
180
><P
111
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
112
195
><P
113
196
></P
114
197
><DIV
121
204
><TT
122
205
CLASS="LITERAL"
123
206
>Current</TT
124
 
>: The current driver in the list of drivers.</P
 
207
>: The current driver in the list of drivers, or NULL to retrieve the first one.</P
125
208
></DD
126
209
><DT
127
210
>Returns</DT
137
220
><H2
138
221
CLASS="SECTION"
139
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
140
293
NAME="DBI-DRIVER-OPEN"
141
 
>4.2.2. dbi_driver_open</A
 
294
>7.2.4. dbi_driver_open</A
142
295
></H2
143
296
><DIV
144
297
CLASS="FUNCSYNOPSIS"
145
298
><P
146
299
></P
147
300
><A
148
 
NAME="AEN437"
 
301
NAME="AEN747"
149
302
></A
150
303
><P
151
304
><CODE
165
318
></DIV
166
319
><P
167
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
168
334
><P
169
335
></P
170
336
><DIV
193
359
><H2
194
360
CLASS="SECTION"
195
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
196
424
NAME="DBI-DRIVER-IS-RESERVED-WORD"
197
 
>4.2.3. dbi_driver_is_reserved_word</A
 
425
>7.2.6. dbi_driver_is_reserved_word</A
198
426
></H2
199
427
><DIV
200
428
CLASS="FUNCSYNOPSIS"
201
429
><P
202
430
></P
203
431
><A
204
 
NAME="AEN456"
 
432
NAME="AEN792"
205
433
></A
206
434
><P
207
435
><CODE
258
486
CLASS="SECTION"
259
487
><A
260
488
NAME="DBI-DRIVER-SPECIFIC-FUNCTION"
261
 
>4.2.4. dbi_driver_specific_function</A
 
489
>7.2.7. dbi_driver_specific_function</A
262
490
></H2
263
491
><DIV
264
492
CLASS="FUNCSYNOPSIS"
265
493
><P
266
494
></P
267
495
><A
268
 
NAME="AEN479"
 
496
NAME="AEN815"
269
497
></A
270
498
><P
271
499
><CODE
313
541
><P
314
542
>If the custom function is found, a pointer to that function. If not, returns NULL.</P
315
543
></DD
 
544
><DT
 
545
>Availability</DT
 
546
><DD
 
547
><P
 
548
>0.9.0</P
 
549
></DD
316
550
></DL
317
551
></DIV
318
552
></DIV
322
556
CLASS="SECTION"
323
557
><A
324
558
NAME="DBI-DRIVER-QUOTE-STRING"
325
 
>4.2.5. dbi_driver_quote_string</A
 
559
>7.2.8. dbi_driver_quote_string</A
326
560
></H2
327
561
><DIV
328
562
CLASS="FUNCSYNOPSIS"
329
563
><P
330
564
></P
331
565
><A
332
 
NAME="AEN502"
 
566
NAME="AEN842"
333
567
></A
334
568
><P
335
569
><CODE
402
636
CLASS="SECTION"
403
637
><A
404
638
NAME="DBI-DRIVER-QUOTE-STRING-COPY"
405
 
>4.2.6. dbi_driver_quote_string_copy</A
 
639
>7.2.9. dbi_driver_quote_string_copy</A
406
640
></H2
407
641
><DIV
408
642
CLASS="FUNCSYNOPSIS"
409
643
><P
410
644
></P
411
645
><A
412
 
NAME="AEN529"
 
646
NAME="AEN869"
413
647
></A
414
648
><P
415
649
><CODE
493
727
CLASS="SECTION"
494
728
><A
495
729
NAME="DBI-DRIVER-ENCODING-FROM-IANA"
496
 
>4.2.7. dbi_driver_encoding_from_iana</A
 
730
>7.2.10. dbi_driver_encoding_from_iana</A
497
731
></H2
498
732
><DIV
499
733
CLASS="FUNCSYNOPSIS"
500
734
><P
501
735
></P
502
736
><A
503
 
NAME="AEN561"
 
737
NAME="AEN901"
504
738
></A
505
739
><P
506
740
><CODE
555
789
><P
556
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
557
791
></DD
 
792
><DT
 
793
>Availability</DT
 
794
><DD
 
795
><P
 
796
>0.8.0</P
 
797
></DD
558
798
></DL
559
799
></DIV
560
800
></DIV
564
804
CLASS="SECTION"
565
805
><A
566
806
NAME="DBI-DRIVER-ENCODING-TO-IANA"
567
 
>4.2.8. dbi_driver_encoding_to_iana</A
 
807
>7.2.11. dbi_driver_encoding_to_iana</A
568
808
></H2
569
809
><DIV
570
810
CLASS="FUNCSYNOPSIS"
571
811
><P
572
812
></P
573
813
><A
574
 
NAME="AEN586"
 
814
NAME="AEN930"
575
815
></A
576
816
><P
577
817
><CODE
623
863
><P
624
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
625
865
></DD
 
866
><DT
 
867
>Availability</DT
 
868
><DD
 
869
><P
 
870
>0.8.0</P
 
871
></DD
626
872
></DL
627
873
></DIV
628
874
></DIV
632
878
CLASS="SECTION"
633
879
><A
634
880
NAME="REFERENCE-DRIVER-INFO"
635
 
>4.2.9. Driver Information</A
 
881
>7.2.12. Driver Information</A
636
882
></H2
637
883
><DIV
638
884
CLASS="SECTION"
640
886
CLASS="SECTION"
641
887
><A
642
888
NAME="DBI-DRIVER-GET-NAME"
643
 
>4.2.9.1. dbi_driver_get_name</A
 
889
>7.2.12.1. dbi_driver_get_name</A
644
890
></H3
645
891
><DIV
646
892
CLASS="FUNCSYNOPSIS"
647
893
><P
648
894
></P
649
895
><A
650
 
NAME="AEN612"
 
896
NAME="AEN960"
651
897
></A
652
898
><P
653
899
><CODE
696
942
CLASS="SECTION"
697
943
><A
698
944
NAME="DBI-DRIVER-GET-FILENAME"
699
 
>4.2.9.2. dbi_driver_get_filename</A
 
945
>7.2.12.2. dbi_driver_get_filename</A
700
946
></H3
701
947
><DIV
702
948
CLASS="FUNCSYNOPSIS"
703
949
><P
704
950
></P
705
951
><A
706
 
NAME="AEN631"
 
952
NAME="AEN979"
707
953
></A
708
954
><P
709
955
><CODE
752
998
CLASS="SECTION"
753
999
><A
754
1000
NAME="DBI-DRIVER-GET-DESCRIPTION"
755
 
>4.2.9.3. dbi_driver_get_description</A
 
1001
>7.2.12.3. dbi_driver_get_description</A
756
1002
></H3
757
1003
><DIV
758
1004
CLASS="FUNCSYNOPSIS"
759
1005
><P
760
1006
></P
761
1007
><A
762
 
NAME="AEN650"
 
1008
NAME="AEN998"
763
1009
></A
764
1010
><P
765
1011
><CODE
805
1051
CLASS="SECTION"
806
1052
><A
807
1053
NAME="DBI-DRIVER-GET-MAINTAINER"
808
 
>4.2.9.4. dbi_driver_get_maintainer</A
 
1054
>7.2.12.4. dbi_driver_get_maintainer</A
809
1055
></H3
810
1056
><DIV
811
1057
CLASS="FUNCSYNOPSIS"
812
1058
><P
813
1059
></P
814
1060
><A
815
 
NAME="AEN668"
 
1061
NAME="AEN1016"
816
1062
></A
817
1063
><P
818
1064
><CODE
861
1107
CLASS="SECTION"
862
1108
><A
863
1109
NAME="DBI-DRIVER-GET-URL"
864
 
>4.2.9.5. dbi_driver_get_url</A
 
1110
>7.2.12.5. dbi_driver_get_url</A
865
1111
></H3
866
1112
><DIV
867
1113
CLASS="FUNCSYNOPSIS"
868
1114
><P
869
1115
></P
870
1116
><A
871
 
NAME="AEN687"
 
1117
NAME="AEN1035"
872
1118
></A
873
1119
><P
874
1120
><CODE
911
1157
CLASS="SECTION"
912
1158
><A
913
1159
NAME="DBI-DRIVER-GET-VERSION"
914
 
>4.2.9.6. dbi_driver_get_version</A
 
1160
>7.2.12.6. dbi_driver_get_version</A
915
1161
></H3
916
1162
><DIV
917
1163
CLASS="FUNCSYNOPSIS"
918
1164
><P
919
1165
></P
920
1166
><A
921
 
NAME="AEN702"
 
1167
NAME="AEN1050"
922
1168
></A
923
1169
><P
924
1170
><CODE
967
1213
CLASS="SECTION"
968
1214
><A
969
1215
NAME="DBI-DRIVER-GET-DATE-COMPILED"
970
 
>4.2.9.7. dbi_driver_get_date_compiled</A
 
1216
>7.2.12.7. dbi_driver_get_date_compiled</A
971
1217
></H3
972
1218
><DIV
973
1219
CLASS="FUNCSYNOPSIS"
974
1220
><P
975
1221
></P
976
1222
><A
977
 
NAME="AEN721"
 
1223
NAME="AEN1069"
978
1224
></A
979
1225
><P
980
1226
><CODE
1017
1263
></DL
1018
1264
></DIV
1019
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
1020
1330
></DIV
1021
1331
></DIV
1022
1332
><DIV
1063
1373
WIDTH="33%"
1064
1374
ALIGN="left"
1065
1375
VALIGN="top"
1066
 
>Core Library Functions</TD
 
1376
>Instance Infrastructure</TD
1067
1377
><TD
1068
1378
WIDTH="34%"
1069
1379
ALIGN="center"