← Back to branch summary

~ubuntu-branches/debian/lenny/freetds/lenny

« back to all changes in this revision

Viewing changes to doc/doc/freetds-0.82/userguide/apireference.htm

  • Committer: Bazaar Package Importer
  • Author(s): Steve Langasek
  • Date: 2008-08-02 11:49:53 UTC
  • mfrom: (2.1.10 intrepid)
  • Revision ID: james.westby@ubuntu.com-20080802114953-0qdeowgl63k42n2c
Tags: 0.82-4
http://bugs.debian.org/493303
* Fix a typo in the freetds-common description, ugh
* Versioned replaces of libct4 by freetds-common, since the current one
  obviously doesn't have overlapping files.
* tdsodbc: check for /var/lib/odbc existence before removing it in the
  postinst, since there are cases where it won't exist on upgrade (i.e.,
  if the driver was never enabled in the first place).  Closes: #493303.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/doc/freetds-0.82/userguide/apireference.htm
 
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
>API Reference Manual</TITLE
 
6
><META
 
7
NAME="GENERATOR"
 
8
CONTENT="Modular DocBook HTML Stylesheet Version 1.79"><LINK
 
9
REL="HOME"
 
10
TITLE="FreeTDS User Guide"
 
11
HREF="index.htm"><LINK
 
12
REL="UP"
 
13
TITLE="Programming"
 
14
HREF="programming.htm"><LINK
 
15
REL="PREVIOUS"
 
16
TITLE="Programming"
 
17
HREF="programming.htm"><LINK
 
18
REL="NEXT"
 
19
TITLE="db-lib API Implementation Summary"
 
20
HREF="dblib.api.summary.htm"><LINK
 
21
REL="STYLESHEET"
 
22
TYPE="text/css"
 
23
HREF="userguide.css"></HEAD
 
24
><BODY
 
25
CLASS="SECT1"
 
26
BGCOLOR="#FFFFFF"
 
27
TEXT="#000000"
 
28
LINK="#0000FF"
 
29
VLINK="#840084"
 
30
ALINK="#0000FF"
 
31
><DIV
 
32
CLASS="NAVHEADER"
 
33
><TABLE
 
34
SUMMARY="Header navigation table"
 
35
WIDTH="100%"
 
36
BORDER="0"
 
37
CELLPADDING="0"
 
38
CELLSPACING="0"
 
39
><TR
 
40
><TH
 
41
COLSPAN="3"
 
42
ALIGN="center"
 
43
><SPAN
 
44
CLASS="PRODUCTNAME"
 
45
>FreeTDS</SPAN
 
46
> User Guide: A Guide to Installing, Configuring, and Running <SPAN
 
47
CLASS="PRODUCTNAME"
 
48
>FreeTDS</SPAN
 
49
></TH
 
50
></TR
 
51
><TR
 
52
><TD
 
53
WIDTH="10%"
 
54
ALIGN="left"
 
55
VALIGN="bottom"
 
56
><A
 
57
HREF="programming.htm"
 
58
ACCESSKEY="P"
 
59
>Prev</A
 
60
></TD
 
61
><TD
 
62
WIDTH="80%"
 
63
ALIGN="center"
 
64
VALIGN="bottom"
 
65
>Chapter 11. Programming</TD
 
66
><TD
 
67
WIDTH="10%"
 
68
ALIGN="right"
 
69
VALIGN="bottom"
 
70
><A
 
71
HREF="dblib.api.summary.htm"
 
72
ACCESSKEY="N"
 
73
>Next</A
 
74
></TD
 
75
></TR
 
76
></TABLE
 
77
><HR
 
78
ALIGN="LEFT"
 
79
WIDTH="100%"></DIV
 
80
><DIV
 
81
CLASS="SECT1"
 
82
><H1
 
83
CLASS="SECT1"
 
84
><A
 
85
NAME="APIREFERENCE"
 
86
>API Reference Manual</A
 
87
></H1
 
88
><P
 
89
>The <A
 
90
HREF="../reference/index.html"
 
91
TARGET="_top"
 
92
>reference manual</A
 
93
> is installed as part of <SPAN
 
94
CLASS="PRODUCTNAME"
 
95
>FreeTDS</SPAN
 
96
>.  It can be regenerated at any time using <SPAN
 
97
CLASS="PRODUCTNAME"
 
98
>Doxygen</SPAN
 
99
> with <B
 
100
CLASS="COMMAND"
 
101
>cd <TT
 
102
CLASS="FILENAME"
 
103
>doc</TT
 
104
>; make doc</B
 
105
>.  
 
106
                        </P
 
107
><P
 
108
>The reference manual is a work in progress: only the db-lib library is completely documented, and quite minimally at that.  Should you find it inadequate, you may be interested to learn it's not hard to add to, technically.  <SPAN
 
109
CLASS="PRODUCTNAME"
 
110
>Doxygen</SPAN
 
111
> generates a manual from encoded comments in the source code.  Its markup syntax is not hard to learn.  You can read more about it at the <A
 
112
HREF="http://www.stack.nl/~dimitri/doxygen/"
 
113
TARGET="_top"
 
114
>Doxygen website</A
 
115
>.  
 
116
                        </P
 
117
><P
 
118
>Basic API coverage information for the db-lib, ct-lib, and ODBC client libraries is maintained in <TT
 
119
CLASS="FILENAME"
 
120
>doc/api_status.txt</TT
 
121
>, included in the source distribution.  For your convenience and enjoyment, we include that file in the following sections.  In each table, we note for the function
 
122
        <A
 
123
NAME="AEN3066"
 
124
HREF="#FTN.AEN3066"
 
125
><SPAN
 
126
CLASS="footnote"
 
127
>[1]</SPAN
 
128
></A
 
129
>
 
130
the extent to which it is implemented.  The <SPAN
 
131
CLASS="emphasis"
 
132
><I
 
133
CLASS="EMPHASIS"
 
134
>Status</I
 
135
></SPAN
 
136
> field may be:
 
137
 
 
138
<P
 
139
></P
 
140
><DIV
 
141
CLASS="VARIABLELIST"
 
142
><P
 
143
><B
 
144
>db-lib API function status domain</B
 
145
></P
 
146
><DL
 
147
><DT
 
148
>(blank)</DT
 
149
><DD
 
150
><P
 
151
>Function is not implemented.</P
 
152
></DD
 
153
><DT
 
154
>stub</DT
 
155
><DD
 
156
><P
 
157
>Function is implemented as a stub.  Some such functions return <TT
 
158
CLASS="LITERAL"
 
159
>SUCCEED</TT
 
160
> even though they have no effect, to satisfy upper layers.  </P
 
161
></DD
 
162
><DT
 
163
>Partial</DT
 
164
><DD
 
165
><P
 
166
>Function is partly implemented.  We haven't dealt with every possible option, for instance.  </P
 
167
></DD
 
168
><DT
 
169
>OK</DT
 
170
><DD
 
171
><P
 
172
>Function is implemented.  Completely, we claim.  </P
 
173
></DD
 
174
></DL
 
175
></DIV
 
176
>
 
177
                        </P
 
178
></DIV
 
179
><H3
 
180
CLASS="FOOTNOTES"
 
181
>Notes</H3
 
182
><TABLE
 
183
BORDER="0"
 
184
CLASS="FOOTNOTES"
 
185
WIDTH="100%"
 
186
><TR
 
187
><TD
 
188
ALIGN="LEFT"
 
189
VALIGN="TOP"
 
190
WIDTH="5%"
 
191
><A
 
192
NAME="FTN.AEN3066"
 
193
HREF="apireference.htm#AEN3066"
 
194
><SPAN
 
195
CLASS="footnote"
 
196
>[1]</SPAN
 
197
></A
 
198
></TD
 
199
><TD
 
200
ALIGN="LEFT"
 
201
VALIGN="TOP"
 
202
WIDTH="95%"
 
203
><P
 
204
>Sybase and Microsoft sometimes use slightly different names for the same function.  It is the intention of the <CODE
 
205
CLASS="OPTION"
 
206
>--enable-msdblib</CODE
 
207
> option to align
 
208
        <SPAN
 
209
CLASS="PRODUCTNAME"
 
210
>FreeTDS</SPAN
 
211
> with one or the other's convention.</P
 
212
></TD
 
213
></TR
 
214
></TABLE
 
215
><DIV
 
216
CLASS="NAVFOOTER"
 
217
><HR
 
218
ALIGN="LEFT"
 
219
WIDTH="100%"><TABLE
 
220
SUMMARY="Footer navigation table"
 
221
WIDTH="100%"
 
222
BORDER="0"
 
223
CELLPADDING="0"
 
224
CELLSPACING="0"
 
225
><TR
 
226
><TD
 
227
WIDTH="33%"
 
228
ALIGN="left"
 
229
VALIGN="top"
 
230
><A
 
231
HREF="programming.htm"
 
232
ACCESSKEY="P"
 
233
>Prev</A
 
234
></TD
 
235
><TD
 
236
WIDTH="34%"
 
237
ALIGN="center"
 
238
VALIGN="top"
 
239
><A
 
240
HREF="index.htm"
 
241
ACCESSKEY="H"
 
242
>Home</A
 
243
></TD
 
244
><TD
 
245
WIDTH="33%"
 
246
ALIGN="right"
 
247
VALIGN="top"
 
248
><A
 
249
HREF="dblib.api.summary.htm"
 
250
ACCESSKEY="N"
 
251
>Next</A
 
252
></TD
 
253
></TR
 
254
><TR
 
255
><TD
 
256
WIDTH="33%"
 
257
ALIGN="left"
 
258
VALIGN="top"
 
259
>Programming</TD
 
260
><TD
 
261
WIDTH="34%"
 
262
ALIGN="center"
 
263
VALIGN="top"
 
264
><A
 
265
HREF="programming.htm"
 
266
ACCESSKEY="U"
 
267
>Up</A
 
268
></TD
 
269
><TD
 
270
WIDTH="33%"
 
271
ALIGN="right"
 
272
VALIGN="top"
 
273
>db-lib API Implementation Summary</TD
 
274
></TR
 
275
></TABLE
 
276
></DIV
 
277
></BODY
 
278
></HTML
 
279
>
 
 
b'\\ No newline at end of file'