1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.18"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>FreeTDS API: Configuration</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">FreeTDS API
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.18 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> |
<a href="#define-members">Macros</a> |
<a href="#func-members">Functions</a> |
<a href="#var-members">Variables</a> </div>
<div class="headertitle">
<div class="title">Configuration<div class="ingroups"><a class="el" href="a00564.html">LibTDS API</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Handle reading of configuration.
<a href="#details">More...</a></p>
<div class="dynheader">
Collaboration diagram for Configuration:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="a00556.svg" width="248" height="36"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
</div>
</div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="a00736.html">tdsvername_t</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:gacc70f24c323b7177050339e069a90c56"><td class="memItemLeft" align="right" valign="top"><a id="gacc70f24c323b7177050339e069a90c56"></a>
#define </td><td class="memItemRight" valign="bottom"><b>TDS_FIND</b>(k, b, c)   tds_find(k, b, TDS_VECTOR_SIZE(b), sizeof(b[0]), c)</td></tr>
<tr class="separator:gacc70f24c323b7177050339e069a90c56"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga369c1a907b111eef229a3e679c914281"><td class="memItemLeft" align="right" valign="top"><a id="ga369c1a907b111eef229a3e679c914281"></a>
static int </td><td class="memItemRight" valign="bottom"><b>hex2num</b> (char *hex)</td></tr>
<tr class="separator:ga369c1a907b111eef229a3e679c914281"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga9f90139b7fd8ac8a1b7ec774513786a1"><td class="memItemLeft" align="right" valign="top"><a id="ga9f90139b7fd8ac8a1b7ec774513786a1"></a>
static int </td><td class="memItemRight" valign="bottom"><b>hexdigit</b> (int c)</td></tr>
<tr class="separator:ga9f90139b7fd8ac8a1b7ec774513786a1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga82ac44924fb1ae41042c233573a4ac8d"><td class="memItemLeft" align="right" valign="top">static int </td><td class="memItemRight" valign="bottom"><a class="el" href="a00556.html#ga82ac44924fb1ae41042c233573a4ac8d">parse_server_name_for_port</a> (<a class="el" href="a01132.html">TDSLOGIN</a> *connection, <a class="el" href="a01132.html">TDSLOGIN</a> *login, bool update_server)</td></tr>
<tr class="memdesc:ga82ac44924fb1ae41042c233573a4ac8d"><td class="mdescLeft"> </td><td class="mdescRight">Check the server name to find port info first Warning: connection-> & login-> are all modified when needed. <a href="a00556.html#ga82ac44924fb1ae41042c233573a4ac8d">More...</a><br /></td></tr>
<tr class="separator:ga82ac44924fb1ae41042c233573a4ac8d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaca20b6e5f5a5ac1727126712dd39564b"><td class="memItemLeft" align="right" valign="top">static int </td><td class="memItemRight" valign="bottom"><a class="el" href="a00556.html#gaca20b6e5f5a5ac1727126712dd39564b">search_interface_file</a> (<a class="el" href="a01132.html">TDSLOGIN</a> *login, const char *dir, const char *file, const char *host)</td></tr>
<tr class="memdesc:gaca20b6e5f5a5ac1727126712dd39564b"><td class="mdescLeft"> </td><td class="mdescRight">Open and read the file 'file' searching for a logical server by the name of 'host'. <a href="a00556.html#gaca20b6e5f5a5ac1727126712dd39564b">More...</a><br /></td></tr>
<tr class="separator:gaca20b6e5f5a5ac1727126712dd39564b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaa3e087e2df44398cbb4741584d2b4f8e"><td class="memItemLeft" align="right" valign="top"><a id="gaa3e087e2df44398cbb4741584d2b4f8e"></a>
int </td><td class="memItemRight" valign="bottom"><b>tds_config_boolean</b> (const char *option, const char *value, <a class="el" href="a01132.html">TDSLOGIN</a> *login)</td></tr>
<tr class="separator:gaa3e087e2df44398cbb4741584d2b4f8e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga409ea4515b5424920b8371295cebaa48"><td class="memItemLeft" align="right" valign="top"><a id="ga409ea4515b5424920b8371295cebaa48"></a>
static void </td><td class="memItemRight" valign="bottom"><b>tds_config_encryption</b> (const char *value, <a class="el" href="a01132.html">TDSLOGIN</a> *login)</td></tr>
<tr class="separator:ga409ea4515b5424920b8371295cebaa48"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga86080f29fb8f43acebbfbb355a4f4874"><td class="memItemLeft" align="right" valign="top"><a id="ga86080f29fb8f43acebbfbb355a4f4874"></a>
static int </td><td class="memItemRight" valign="bottom"><b>tds_config_env_tdsdump</b> (<a class="el" href="a01132.html">TDSLOGIN</a> *login)</td></tr>
<tr class="separator:ga86080f29fb8f43acebbfbb355a4f4874"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gac598ca7c689d62d1535874f40132cc44"><td class="memItemLeft" align="right" valign="top"><a id="gac598ca7c689d62d1535874f40132cc44"></a>
static int </td><td class="memItemRight" valign="bottom"><b>tds_config_env_tdshost</b> (<a class="el" href="a01132.html">TDSLOGIN</a> *login)</td></tr>
<tr class="separator:gac598ca7c689d62d1535874f40132cc44"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga9d076eb297543cb61e07cabd4220d540"><td class="memItemLeft" align="right" valign="top"><a id="ga9d076eb297543cb61e07cabd4220d540"></a>
static void </td><td class="memItemRight" valign="bottom"><b>tds_config_env_tdsport</b> (<a class="el" href="a01132.html">TDSLOGIN</a> *login)</td></tr>
<tr class="separator:ga9d076eb297543cb61e07cabd4220d540"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga6d870fe4597d567aac9c4464b04a3c54"><td class="memItemLeft" align="right" valign="top"><a id="ga6d870fe4597d567aac9c4464b04a3c54"></a>
static void </td><td class="memItemRight" valign="bottom"><b>tds_config_env_tdsver</b> (<a class="el" href="a01132.html">TDSLOGIN</a> *login)</td></tr>
<tr class="separator:ga6d870fe4597d567aac9c4464b04a3c54"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga8db0faf6db365134a553cc4b43b420e5"><td class="memItemLeft" align="right" valign="top"><a id="ga8db0faf6db365134a553cc4b43b420e5"></a>
static int </td><td class="memItemRight" valign="bottom"><b>tds_config_login</b> (<a class="el" href="a01132.html">TDSLOGIN</a> *connection, <a class="el" href="a01132.html">TDSLOGIN</a> *login)</td></tr>
<tr class="separator:ga8db0faf6db365134a553cc4b43b420e5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gade94d7e89ba1f668c82be0b00a7f5cd7"><td class="memItemLeft" align="right" valign="top">TDS_USMALLINT * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00556.html#gade94d7e89ba1f668c82be0b00a7f5cd7">tds_config_verstr</a> (const char *tdsver, <a class="el" href="a01132.html">TDSLOGIN</a> *login)</td></tr>
<tr class="memdesc:gade94d7e89ba1f668c82be0b00a7f5cd7"><td class="mdescLeft"> </td><td class="mdescRight">Set TDS version from given string. <a href="a00556.html#gade94d7e89ba1f668c82be0b00a7f5cd7">More...</a><br /></td></tr>
<tr class="separator:gade94d7e89ba1f668c82be0b00a7f5cd7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gabcc0322da1a1d9b47ee4c22aa1d61778"><td class="memItemLeft" align="right" valign="top"><a id="gabcc0322da1a1d9b47ee4c22aa1d61778"></a>
static void * </td><td class="memItemRight" valign="bottom"><b>tds_find</b> (const void *key, const void *base, size_t nelem, size_t width, int(*compar)(const void *, const void *))</td></tr>
<tr class="separator:gabcc0322da1a1d9b47ee4c22aa1d61778"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gacee4f06ba749b10ee9f2e5bb1c4a8910"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00556.html#gacee4f06ba749b10ee9f2e5bb1c4a8910">tds_fix_login</a> (<a class="el" href="a01132.html">TDSLOGIN</a> *login)</td></tr>
<tr class="memdesc:gacee4f06ba749b10ee9f2e5bb1c4a8910"><td class="mdescLeft"> </td><td class="mdescRight">Fix configuration after reading it. <a href="a00556.html#gacee4f06ba749b10ee9f2e5bb1c4a8910">More...</a><br /></td></tr>
<tr class="separator:gacee4f06ba749b10ee9f2e5bb1c4a8910"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga860690ac47a80f74c83b25cbd8d7703d"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="a00437.html#a1de034b895312fc0cfae0e28f8921a47">TDS_COMPILETIME_SETTINGS</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00556.html#ga860690ac47a80f74c83b25cbd8d7703d">tds_get_compiletime_settings</a> (void)</td></tr>
<tr class="memdesc:ga860690ac47a80f74c83b25cbd8d7703d"><td class="mdescLeft"> </td><td class="mdescRight">Return a structure capturing the compile-time settings provided to the configure script. <a href="a00556.html#ga860690ac47a80f74c83b25cbd8d7703d">More...</a><br /></td></tr>
<tr class="separator:ga860690ac47a80f74c83b25cbd8d7703d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga606b41d6d4d613d9581c61aa74c8211d"><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00556.html#ga606b41d6d4d613d9581c61aa74c8211d">tds_get_home_file</a> (const char *file)</td></tr>
<tr class="memdesc:ga606b41d6d4d613d9581c61aa74c8211d"><td class="mdescLeft"> </td><td class="mdescRight">Return filename from HOME directory. <a href="a00556.html#ga606b41d6d4d613d9581c61aa74c8211d">More...</a><br /></td></tr>
<tr class="separator:ga606b41d6d4d613d9581c61aa74c8211d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaa17936ef93e1c68833c4aab769bd90d9"><td class="memItemLeft" align="right" valign="top">struct addrinfo * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00556.html#gaa17936ef93e1c68833c4aab769bd90d9">tds_lookup_host</a> (const char *servername)</td></tr>
<tr class="memdesc:gaa17936ef93e1c68833c4aab769bd90d9"><td class="mdescLeft"> </td><td class="mdescRight">Get the IP address for a hostname. <a href="a00556.html#gaa17936ef93e1c68833c4aab769bd90d9">More...</a><br /></td></tr>
<tr class="separator:gaa17936ef93e1c68833c4aab769bd90d9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga15536d5f0812e156705ed168f5b56b35"><td class="memItemLeft" align="right" valign="top"><a id="ga15536d5f0812e156705ed168f5b56b35"></a>
TDSRET </td><td class="memItemRight" valign="bottom"><b>tds_lookup_host_set</b> (const char *servername, struct addrinfo **addr)</td></tr>
<tr class="separator:ga15536d5f0812e156705ed168f5b56b35"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga45281d1cb2ac649db65d80bb3ff06b66"><td class="memItemLeft" align="right" valign="top">static int </td><td class="memItemRight" valign="bottom"><a class="el" href="a00556.html#ga45281d1cb2ac649db65d80bb3ff06b66">tds_lookup_port</a> (const char *portname)</td></tr>
<tr class="memdesc:ga45281d1cb2ac649db65d80bb3ff06b66"><td class="mdescLeft"> </td><td class="mdescRight">Given a portname lookup the port. <a href="a00556.html#ga45281d1cb2ac649db65d80bb3ff06b66">More...</a><br /></td></tr>
<tr class="separator:ga45281d1cb2ac649db65d80bb3ff06b66"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaa786931199373e617afbf7198e251ce8"><td class="memItemLeft" align="right" valign="top"><a id="gaa786931199373e617afbf7198e251ce8"></a>
int </td><td class="memItemRight" valign="bottom"><b>tds_parse_boolean</b> (const char *value, int default_value)</td></tr>
<tr class="separator:gaa786931199373e617afbf7198e251ce8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga3e63911fa1b576b353452295be13765a"><td class="memItemLeft" align="right" valign="top"><a id="ga3e63911fa1b576b353452295be13765a"></a>
void </td><td class="memItemRight" valign="bottom"><b>tds_parse_conf_section</b> (const char *option, const char *value, void *param)</td></tr>
<tr class="separator:ga3e63911fa1b576b353452295be13765a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga4799b423b5d982dbc8f31b7738255eef"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00556.html#ga4799b423b5d982dbc8f31b7738255eef">tds_read_conf_file</a> (<a class="el" href="a01132.html">TDSLOGIN</a> *login, const char *server)</td></tr>
<tr class="memdesc:ga4799b423b5d982dbc8f31b7738255eef"><td class="mdescLeft"> </td><td class="mdescRight">Read configuration info for given server return 0 on error. <a href="a00556.html#ga4799b423b5d982dbc8f31b7738255eef">More...</a><br /></td></tr>
<tr class="separator:ga4799b423b5d982dbc8f31b7738255eef"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga44fdbe16827097d947f900d96003de98"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00556.html#ga44fdbe16827097d947f900d96003de98">tds_read_conf_section</a> (FILE *in, const char *section, TDSCONFPARSE tds_conf_parse, void *param)</td></tr>
<tr class="memdesc:ga44fdbe16827097d947f900d96003de98"><td class="mdescLeft"> </td><td class="mdescRight">Read a section of configuration file (INI style file) <a href="a00556.html#ga44fdbe16827097d947f900d96003de98">More...</a><br /></td></tr>
<tr class="separator:ga44fdbe16827097d947f900d96003de98"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaf2e820302d0f47191e038442d9a4b459"><td class="memItemLeft" align="right" valign="top"><a id="gaf2e820302d0f47191e038442d9a4b459"></a>
static bool </td><td class="memItemRight" valign="bottom"><b>tds_read_conf_sections</b> (FILE *in, const char *server, <a class="el" href="a01132.html">TDSLOGIN</a> *login)</td></tr>
<tr class="separator:gaf2e820302d0f47191e038442d9a4b459"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga9af192306186ddf39e09be0fd4ad8aaf"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a01132.html">TDSLOGIN</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00556.html#ga9af192306186ddf39e09be0fd4ad8aaf">tds_read_config_info</a> (<a class="el" href="a01224.html">TDSSOCKET</a> *tds, <a class="el" href="a01132.html">TDSLOGIN</a> *login, <a class="el" href="a01140.html">TDSLOCALE</a> *locale)</td></tr>
<tr class="memdesc:ga9af192306186ddf39e09be0fd4ad8aaf"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="a00556.html#ga9af192306186ddf39e09be0fd4ad8aaf" title="tds_read_config_info() will fill the tds connection structure based on configuration information gath...">tds_read_config_info()</a> will fill the tds connection structure based on configuration information gathered in the following order: 1) Program specified in TDSLOGIN structure 2) The environment variables TDSVER, TDSDUMP, TDSPORT, TDSQUERY, TDSHOST 3) A config file with the following search order: a) a readable file specified by environment variable FREETDSCONF b) a readable file in ~/.freetds.conf c) a readable file in $prefix/etc/freetds.conf 3) ~/.interfaces if exists 4) $SYBASE/interfaces if exists 5) TDS_DEF_* default values <a href="a00556.html#ga9af192306186ddf39e09be0fd4ad8aaf">More...</a><br /></td></tr>
<tr class="separator:ga9af192306186ddf39e09be0fd4ad8aaf"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga6631af35ee817f93827c62bbda41674a"><td class="memItemLeft" align="right" valign="top">static int </td><td class="memItemRight" valign="bottom"><a class="el" href="a00556.html#ga6631af35ee817f93827c62bbda41674a">tds_read_interfaces</a> (const char *server, <a class="el" href="a01132.html">TDSLOGIN</a> *login)</td></tr>
<tr class="memdesc:ga6631af35ee817f93827c62bbda41674a"><td class="mdescLeft"> </td><td class="mdescRight">Try to find the IP number and port for a (possibly) logical server name. <a href="a00556.html#ga6631af35ee817f93827c62bbda41674a">More...</a><br /></td></tr>
<tr class="separator:ga6631af35ee817f93827c62bbda41674a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga57cea6e376d7c2d28b811a5b0053210c"><td class="memItemLeft" align="right" valign="top">TDSRET </td><td class="memItemRight" valign="bottom"><a class="el" href="a00556.html#ga57cea6e376d7c2d28b811a5b0053210c">tds_set_interfaces_file_loc</a> (const char *interf)</td></tr>
<tr class="memdesc:ga57cea6e376d7c2d28b811a5b0053210c"><td class="mdescLeft"> </td><td class="mdescRight">Set the full name of interface file. <a href="a00556.html#ga57cea6e376d7c2d28b811a5b0053210c">More...</a><br /></td></tr>
<tr class="separator:ga57cea6e376d7c2d28b811a5b0053210c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaa7e9ddb13f45a24a3402f2e21bb24cdc"><td class="memItemLeft" align="right" valign="top"><a id="gaa7e9ddb13f45a24a3402f2e21bb24cdc"></a>
static bool </td><td class="memItemRight" valign="bottom"><b>tds_try_conf_file</b> (const char *path, const char *how, const char *server, <a class="el" href="a01132.html">TDSLOGIN</a> *login)</td></tr>
<tr class="separator:gaa7e9ddb13f45a24a3402f2e21bb24cdc"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga36253e4169c83926fe31e3de57ff6ef5"><td class="memItemLeft" align="right" valign="top"><a id="ga36253e4169c83926fe31e3de57ff6ef5"></a>
static int </td><td class="memItemRight" valign="bottom"><b>tds_vernanme_cmp</b> (const void *key, const void *pelem)</td></tr>
<tr class="separator:ga36253e4169c83926fe31e3de57ff6ef5"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="var-members"></a>
Variables</h2></td></tr>
<tr class="memitem:gabba989d1ca2c52bada005d42a752fb6a"><td class="memItemLeft" >struct {</td></tr>
<tr class="memitem:gabdb79547ea5c54112b48be39b67fc366"><td class="memItemLeft" >
   unsigned char   <b>to_return</b></td></tr>
<tr class="separator:gabdb79547ea5c54112b48be39b67fc366"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gad1c6db49897958d2399d69712acf6eb4"><td class="memItemLeft" >
   char   <b>value</b> [7]</td></tr>
<tr class="separator:gad1c6db49897958d2399d69712acf6eb4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gabba989d1ca2c52bada005d42a752fb6a"><td class="memItemLeft" valign="top">} </td><td class="memItemRight" valign="bottom"><b>boolean_values</b> []</td></tr>
<tr class="separator:gabba989d1ca2c52bada005d42a752fb6a"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>Handle reading of configuration. </p>
<h2 class="groupheader">Function Documentation</h2>
<a id="ga82ac44924fb1ae41042c233573a4ac8d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga82ac44924fb1ae41042c233573a4ac8d">◆ </a></span>parse_server_name_for_port()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static int parse_server_name_for_port </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a01132.html">TDSLOGIN</a> * </td>
<td class="paramname"><em>connection</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="a01132.html">TDSLOGIN</a> * </td>
<td class="paramname"><em>login</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>update_server</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Check the server name to find port info first Warning: connection-> & login-> are all modified when needed. </p>
<dl class="section return"><dt>Returns</dt><dd>1 when found, else 0 </dd></dl>
<div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="a00556_ga82ac44924fb1ae41042c233573a4ac8d_cgraph.svg" width="508" height="139"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
</div>
</div>
</div>
</div>
<a id="gaca20b6e5f5a5ac1727126712dd39564b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaca20b6e5f5a5ac1727126712dd39564b">◆ </a></span>search_interface_file()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static int search_interface_file </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a01132.html">TDSLOGIN</a> * </td>
<td class="paramname"><em>login</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>dir</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>file</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>host</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Open and read the file 'file' searching for a logical server by the name of 'host'. </p>
<p>If one is found then lookup the IP address and port number and store them in 'login'</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">dir</td><td>name of base directory for interface file </td></tr>
<tr><td class="paramname">file</td><td>name of the interface file </td></tr>
<tr><td class="paramname">host</td><td>logical host to search for </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 if not fount 1 if found </dd></dl>
<div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="a00556_gaca20b6e5f5a5ac1727126712dd39564b_cgraph.svg" width="298" height="38"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
</div>
</div>
</div>
</div>
<a id="gade94d7e89ba1f668c82be0b00a7f5cd7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gade94d7e89ba1f668c82be0b00a7f5cd7">◆ </a></span>tds_config_verstr()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">TDS_USMALLINT* tds_config_verstr </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>tdsver</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="a01132.html">TDSLOGIN</a> * </td>
<td class="paramname"><em>login</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set TDS version from given string. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">tdsver</td><td>tds string version </td></tr>
<tr><td class="paramname">login</td><td>where to store information </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>as encoded hex value: high nybble major, low nybble minor. </dd></dl>
</div>
</div>
<a id="gacee4f06ba749b10ee9f2e5bb1c4a8910"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gacee4f06ba749b10ee9f2e5bb1c4a8910">◆ </a></span>tds_fix_login()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void tds_fix_login </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a01132.html">TDSLOGIN</a> * </td>
<td class="paramname"><em>login</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Fix configuration after reading it. </p>
<p>Currently this read some environment variables and replace some options. </p>
</div>
</div>
<a id="ga860690ac47a80f74c83b25cbd8d7703d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga860690ac47a80f74c83b25cbd8d7703d">◆ </a></span>tds_get_compiletime_settings()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="a00437.html#a1de034b895312fc0cfae0e28f8921a47">TDS_COMPILETIME_SETTINGS</a>* tds_get_compiletime_settings </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Return a structure capturing the compile-time settings provided to the configure script. </p>
<p><br />
</p>
</div>
</div>
<a id="ga606b41d6d4d613d9581c61aa74c8211d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga606b41d6d4d613d9581c61aa74c8211d">◆ </a></span>tds_get_home_file()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char* tds_get_home_file </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>file</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Return filename from HOME directory. </p>
<dl class="section return"><dt>Returns</dt><dd>allocated string or NULL if error </dd></dl>
</div>
</div>
<a id="gaa17936ef93e1c68833c4aab769bd90d9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaa17936ef93e1c68833c4aab769bd90d9">◆ </a></span>tds_lookup_host()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct addrinfo* tds_lookup_host </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>servername</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the IP address for a hostname. </p>
<p>Store server's IP address in the string 'ip' in dotted-decimal notation. (The "hostname" might itself be a dotted-decimal address. <br />
</p>
<p>If we can't determine the IP address then 'ip' will be set to empty string. </p>
</div>
</div>
<a id="ga45281d1cb2ac649db65d80bb3ff06b66"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga45281d1cb2ac649db65d80bb3ff06b66">◆ </a></span>tds_lookup_port()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static int tds_lookup_port </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>portname</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Given a portname lookup the port. </p>
<p>If we can't determine the port number then return 0. </p>
</div>
</div>
<a id="ga4799b423b5d982dbc8f31b7738255eef"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga4799b423b5d982dbc8f31b7738255eef">◆ </a></span>tds_read_conf_file()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool tds_read_conf_file </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a01132.html">TDSLOGIN</a> * </td>
<td class="paramname"><em>login</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>server</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Read configuration info for given server return 0 on error. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">login</td><td>where to store configuration </td></tr>
<tr><td class="paramname">server</td><td>section of file configuration that hold configuration for a server </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga44fdbe16827097d947f900d96003de98"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga44fdbe16827097d947f900d96003de98">◆ </a></span>tds_read_conf_section()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool tds_read_conf_section </td>
<td>(</td>
<td class="paramtype">FILE * </td>
<td class="paramname"><em>in</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>section</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">TDSCONFPARSE </td>
<td class="paramname"><em>tds_conf_parse</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>param</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Read a section of configuration file (INI style file) </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">in</td><td>configuration file </td></tr>
<tr><td class="paramname">section</td><td>section to read </td></tr>
<tr><td class="paramname">tds_conf_parse</td><td>callback that receive every entry in section </td></tr>
<tr><td class="paramname">param</td><td>parameter to pass to callback function </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga9af192306186ddf39e09be0fd4ad8aaf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga9af192306186ddf39e09be0fd4ad8aaf">◆ </a></span>tds_read_config_info()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a01132.html">TDSLOGIN</a>* tds_read_config_info </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a01224.html">TDSSOCKET</a> * </td>
<td class="paramname"><em>tds</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="a01132.html">TDSLOGIN</a> * </td>
<td class="paramname"><em>login</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="a01140.html">TDSLOCALE</a> * </td>
<td class="paramname"><em>locale</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p><a class="el" href="a00556.html#ga9af192306186ddf39e09be0fd4ad8aaf" title="tds_read_config_info() will fill the tds connection structure based on configuration information gath...">tds_read_config_info()</a> will fill the tds connection structure based on configuration information gathered in the following order: 1) Program specified in TDSLOGIN structure 2) The environment variables TDSVER, TDSDUMP, TDSPORT, TDSQUERY, TDSHOST 3) A config file with the following search order: a) a readable file specified by environment variable FREETDSCONF b) a readable file in ~/.freetds.conf c) a readable file in $prefix/etc/freetds.conf 3) ~/.interfaces if exists 4) $SYBASE/interfaces if exists 5) TDS_DEF_* default values </p>
<p>.tdsrc and freetds.conf have been added to make the package easier to integration with various Linux and *BSD distributions. </p>
</div>
</div>
<a id="ga6631af35ee817f93827c62bbda41674a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga6631af35ee817f93827c62bbda41674a">◆ </a></span>tds_read_interfaces()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static int tds_read_interfaces </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>server</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="a01132.html">TDSLOGIN</a> * </td>
<td class="paramname"><em>login</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Try to find the IP number and port for a (possibly) logical server name. </p>
<dl class="section note"><dt>Note</dt><dd>This function uses only the interfaces file and is deprecated. </dd></dl>
<div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="a00556_ga6631af35ee817f93827c62bbda41674a_cgraph.svg" width="291" height="38"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
</div>
</div>
</div>
</div>
<a id="ga57cea6e376d7c2d28b811a5b0053210c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga57cea6e376d7c2d28b811a5b0053210c">◆ </a></span>tds_set_interfaces_file_loc()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">TDSRET tds_set_interfaces_file_loc </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>interf</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the full name of interface file. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">interf</td><td>file name </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Variable Documentation</h2>
<a id="gabba989d1ca2c52bada005d42a752fb6a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gabba989d1ca2c52bada005d42a752fb6a">◆ </a></span>boolean_values</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const { ... } boolean_values[]</td>
</tr>
</table>
</div><div class="memdoc">
<b>Initial value:</b><div class="fragment"><div class="line">= {</div>
<div class="line"> { <span class="stringliteral">"yes"</span>, 1 },</div>
<div class="line"> { <span class="stringliteral">"no"</span>, 0 },</div>
<div class="line"> { <span class="stringliteral">"on"</span>, 1 },</div>
<div class="line"> { <span class="stringliteral">"off"</span>, 0 },</div>
<div class="line"> { <span class="stringliteral">"true"</span>, 1 },</div>
<div class="line"> { <span class="stringliteral">"false"</span>, 0 }</div>
<div class="line">}</div>
</div><!-- fragment -->
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.18
</small></address>
</body>
</html>
|
