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
|
<!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: The db-lib API</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="#groups">Modules</a> |
<a href="#define-members">Macros</a> </div>
<div class="headertitle">
<div class="title">The db-lib API</div> </div>
</div><!--header-->
<div class="contents">
<p>Functions callable by <code>db-lib</code> client programs.
<a href="#details">More...</a></p>
<div class="dynheader">
Collaboration diagram for The db-lib API:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="a00544.svg" width="351" height="332"><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="groups"></a>
Modules</h2></td></tr>
<tr class="memitem:a00545"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00545.html">Primary functions</a></td></tr>
<tr class="memdesc:a00545"><td class="mdescLeft"> </td><td class="mdescRight">Core functions needed by most db-lib programs. <br />
<br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a00546"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00546.html">Remote Procedure functions</a></td></tr>
<tr class="memdesc:a00546"><td class="mdescLeft"> </td><td class="mdescRight">Functions used with stored procedures. <br />
Especially useful for OUTPUT parameters, because modern Microsoft servers do not return output parameter data to the client unless the procedure was invoked with <a class="el" href="a00546.html#gafa4dfd181be21e49c397f7daaa9cf96c" title="Execute the procedure and free associated memory.">dbrpcsend()</a>. <br />
<br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a00547"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00547.html">Bulk copy functions</a></td></tr>
<tr class="memdesc:a00547"><td class="mdescLeft"> </td><td class="mdescRight">Functions to bulk-copy (a/k/a <em>bcp</em>) data to/from the database. <br />
<br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a00549"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00549.html">Money functions</a></td></tr>
<tr class="memdesc:a00549"><td class="mdescLeft"> </td><td class="mdescRight">Functions to manipulate the MONEY datatype. <br />
<br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a00550"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00550.html">Datetime functions</a></td></tr>
<tr class="memdesc:a00550"><td class="mdescLeft"> </td><td class="mdescRight">Functions to manipulate <a class="el" href="a01308.html">DBDATETIME</a> structures. Defined by Sybase only. <br />
These are not implemented: <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a00551"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00551.html">Internals</a></td></tr>
<tr class="memdesc:a00551"><td class="mdescLeft"> </td><td class="mdescRight">Functions called within <code>db-lib</code> for self-help. <br />
These functions are of interest only to people hacking on the FreeTDS db-lib implementation. <br />
<br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a00552"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00552.html">Unimplemented</a></td></tr>
<tr class="memdesc:a00552"><td class="mdescLeft"> </td><td class="mdescRight">Functions thus far not implemented in the FreeTDS db-lib implementation. <br />
While some of these are simply awaiting someone with time and skill (and inclination) it might be noted here that the old browse functions (e.g. dbcolbrowse()) are on the never-to-do list. <br />
They were defined by Sybase and were superseded long ago, although they're still present in Microsoft's implementation. <br />
They were never popular and today better alternatives are available. <br />
For completeness, they are: <br /></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:ga5a626d228e82be0af8449d2b8c278241"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="a00544.html#ga5a626d228e82be0af8449d2b8c278241">BCP_SETL</a>(x, y)   <a class="el" href="a00551.html#ga03e850369aca6fba074da5e9da4effd7">dbsetlbool</a>((x), (y), DBSETBCP)</td></tr>
<tr class="memdesc:ga5a626d228e82be0af8449d2b8c278241"><td class="mdescLeft"> </td><td class="mdescRight">Enable (or prevent) bcp operations for connections made with a login. <br />
<a href="a00544.html#ga5a626d228e82be0af8449d2b8c278241">More...</a><br /></td></tr>
<tr class="separator:ga5a626d228e82be0af8449d2b8c278241"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gab6c2da7fd615cf7462d555e5387a5580"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="a00544.html#gab6c2da7fd615cf7462d555e5387a5580">DBSETLAPP</a>(x, y)   <a class="el" href="a00551.html#gae1fc46447c4f8a9ff7f66607b8cd23b6">dbsetlname</a>((x), (y), DBSETAPP)</td></tr>
<tr class="memdesc:gab6c2da7fd615cf7462d555e5387a5580"><td class="mdescLeft"> </td><td class="mdescRight">Set the (client) application name in the login packet. <br />
<a href="a00544.html#gab6c2da7fd615cf7462d555e5387a5580">More...</a><br /></td></tr>
<tr class="separator:gab6c2da7fd615cf7462d555e5387a5580"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaef0e7a5fcf2d8c8f795b2b06ce4de8b1"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="a00544.html#gaef0e7a5fcf2d8c8f795b2b06ce4de8b1">DBSETLHOST</a>(x, y)   <a class="el" href="a00551.html#gae1fc46447c4f8a9ff7f66607b8cd23b6">dbsetlname</a>((x), (y), DBSETHOST)</td></tr>
<tr class="memdesc:gaef0e7a5fcf2d8c8f795b2b06ce4de8b1"><td class="mdescLeft"> </td><td class="mdescRight">Set the (client) host name in the login packet. <br />
<a href="a00544.html#gaef0e7a5fcf2d8c8f795b2b06ce4de8b1">More...</a><br /></td></tr>
<tr class="separator:gaef0e7a5fcf2d8c8f795b2b06ce4de8b1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga61e04e8e2f0d7f1740d40634041f98eb"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="a00544.html#ga61e04e8e2f0d7f1740d40634041f98eb">DBSETLPWD</a>(x, y)   <a class="el" href="a00551.html#gae1fc46447c4f8a9ff7f66607b8cd23b6">dbsetlname</a>((x), (y), DBSETPWD)</td></tr>
<tr class="memdesc:ga61e04e8e2f0d7f1740d40634041f98eb"><td class="mdescLeft"> </td><td class="mdescRight">Set the password in the login packet. <br />
<a href="a00544.html#ga61e04e8e2f0d7f1740d40634041f98eb">More...</a><br /></td></tr>
<tr class="separator:ga61e04e8e2f0d7f1740d40634041f98eb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gafbe7e48171d2f9b1d4f99e0bfdd98f5e"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="a00544.html#gafbe7e48171d2f9b1d4f99e0bfdd98f5e">DBSETLUSER</a>(x, y)   <a class="el" href="a00551.html#gae1fc46447c4f8a9ff7f66607b8cd23b6">dbsetlname</a>((x), (y), DBSETUSER)</td></tr>
<tr class="memdesc:gafbe7e48171d2f9b1d4f99e0bfdd98f5e"><td class="mdescLeft"> </td><td class="mdescRight">Set the username in the login packet. <br />
<a href="a00544.html#gafbe7e48171d2f9b1d4f99e0bfdd98f5e">More...</a><br /></td></tr>
<tr class="separator:gafbe7e48171d2f9b1d4f99e0bfdd98f5e"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>Functions callable by <code>db-lib</code> client programs. </p>
<p>The <code>db_lib</code> interface is implemented by both Sybase and Microsoft. FreeTDS seeks to implement first the intersection of the functions defined by the vendors. <br />
</p>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a id="ga5a626d228e82be0af8449d2b8c278241"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga5a626d228e82be0af8449d2b8c278241">◆ </a></span>BCP_SETL</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">BCP_SETL</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">x, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname">y </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td>   <a class="el" href="a00551.html#ga03e850369aca6fba074da5e9da4effd7">dbsetlbool</a>((x), (y), DBSETBCP)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Enable (or prevent) bcp operations for connections made with a login. <br />
</p>
<dl class="section see"><dt>See also</dt><dd>bcp_setl() </dd></dl>
</div>
</div>
<a id="gab6c2da7fd615cf7462d555e5387a5580"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gab6c2da7fd615cf7462d555e5387a5580">◆ </a></span>DBSETLAPP</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">DBSETLAPP</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">x, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname">y </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td>   <a class="el" href="a00551.html#gae1fc46447c4f8a9ff7f66607b8cd23b6">dbsetlname</a>((x), (y), DBSETAPP)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the (client) application name in the login packet. <br />
</p>
<dl class="section see"><dt>See also</dt><dd>dbsetlapp() </dd></dl>
</div>
</div>
<a id="gaef0e7a5fcf2d8c8f795b2b06ce4de8b1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaef0e7a5fcf2d8c8f795b2b06ce4de8b1">◆ </a></span>DBSETLHOST</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">DBSETLHOST</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">x, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname">y </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td>   <a class="el" href="a00551.html#gae1fc46447c4f8a9ff7f66607b8cd23b6">dbsetlname</a>((x), (y), DBSETHOST)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the (client) host name in the login packet. <br />
</p>
<dl class="section see"><dt>See also</dt><dd>dbsetlhost() </dd></dl>
</div>
</div>
<a id="ga61e04e8e2f0d7f1740d40634041f98eb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga61e04e8e2f0d7f1740d40634041f98eb">◆ </a></span>DBSETLPWD</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">DBSETLPWD</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">x, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname">y </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td>   <a class="el" href="a00551.html#gae1fc46447c4f8a9ff7f66607b8cd23b6">dbsetlname</a>((x), (y), DBSETPWD)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the password in the login packet. <br />
</p>
<dl class="section see"><dt>See also</dt><dd>dbsetlpwd() </dd></dl>
</div>
</div>
<a id="gafbe7e48171d2f9b1d4f99e0bfdd98f5e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gafbe7e48171d2f9b1d4f99e0bfdd98f5e">◆ </a></span>DBSETLUSER</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">DBSETLUSER</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">x, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname">y </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td>   <a class="el" href="a00551.html#gae1fc46447c4f8a9ff7f66607b8cd23b6">dbsetlname</a>((x), (y), DBSETUSER)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the username in the login packet. <br />
</p>
<dl class="section see"><dt>See also</dt><dd>dbsetluser() </dd></dl>
</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>
|
