]> git.saurik.com Git - wxWidgets.git/blame - include/wx/isql.h
clear up wxStringBuffer docs a bit
[wxWidgets.git] / include / wx / isql.h
CommitLineData
d76fe38b
RR
1/*
2 * isql.h
3 *
4 * $Id$
5 *
6 * iODBC defines
7 *
8 * The iODBC driver manager.
bbc3f89a
DW
9 *
10 * Copyright (C) 1995 by Ke Jin <kejin@empress.com>
d76fe38b
RR
11 *
12 * This library is free software; you can redistribute it and/or
13 * modify it under the terms of the GNU Library General Public
14 * License as published by the Free Software Foundation; either
15 * version 2 of the License, or (at your option) any later version.
16 *
17 * This library is distributed in the hope that it will be useful,
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
20 * Library General Public License for more details.
21 *
22 * You should have received a copy of the GNU Library General Public
23 * License along with this library; if not, write to the Free
24 * Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
25 */
26#ifndef _ISQL_H
27#define _ISQL_H
28
3a5bcc4d 29#if defined(WIN32)
7beb59f3 30#define SQL_API __stdcall
96820af7 31
bbc3f89a
DW
32#ifndef FAR
33#define FAR
34#endif
35
36#elif defined(__OS2__)
7beb59f3 37#define SQL_API _Optlink
bbc3f89a
DW
38
39#ifndef FAR
40#define FAR
41#define EXPORT
42#define CALLBACK
96820af7
BJ
43#endif
44
d76fe38b
RR
45#else
46#define FAR
47#define EXPORT
48#define CALLBACK
7beb59f3 49#define SQL_API EXPORT CALLBACK
d76fe38b 50
64a1d923 51#ifndef __EMX__
d76fe38b
RR
52typedef void *HWND;
53#endif
64a1d923 54#endif
d76fe38b
RR
55
56typedef void *SQLHWND;
57
58typedef unsigned char UCHAR;
59typedef long int SDWORD;
60typedef short int SWORD;
61typedef unsigned long int UDWORD;
62typedef unsigned short int UWORD;
63
64typedef void FAR *PTR;
65typedef void FAR *HENV;
66typedef void FAR *HDBC;
67typedef void FAR *HSTMT;
68
69typedef signed short RETCODE;
7beb59f3 70#define SQLRETURN RETCODE
d76fe38b
RR
71
72
7beb59f3 73#define ODBCVER 0x0250
d76fe38b 74
7beb59f3
WS
75#define SQL_MAX_MESSAGE_LENGTH 512
76#define SQL_MAX_DSN_LENGTH 32
d76fe38b
RR
77
78/*
79 * Function return codes
80 */
7beb59f3
WS
81#define SQL_INVALID_HANDLE (-2)
82#define SQL_ERROR (-1)
83#define SQL_SUCCESS 0
84#define SQL_SUCCESS_WITH_INFO 1
85#define SQL_NO_DATA_FOUND 100
d76fe38b
RR
86
87/*
88 * Standard SQL datatypes, using ANSI type numbering
89 */
7beb59f3
WS
90#define SQL_CHAR 1
91#define SQL_NUMERIC 2
92#define SQL_DECIMAL 3
93#define SQL_INTEGER 4
94#define SQL_SMALLINT 5
95#define SQL_FLOAT 6
96#define SQL_REAL 7
97#define SQL_DOUBLE 8
98#define SQL_VARCHAR 12
99
100#define SQL_TYPE_MIN SQL_CHAR
101#define SQL_TYPE_NULL 0
102#define SQL_TYPE_MAX SQL_VARCHAR
d76fe38b
RR
103
104/*
105 * C datatype to SQL datatype mapping
106 */
7beb59f3
WS
107#define SQL_C_CHAR SQL_CHAR
108#define SQL_C_LONG SQL_INTEGER
109#define SQL_C_SHORT SQL_SMALLINT
110#define SQL_C_FLOAT SQL_REAL
111#define SQL_C_DOUBLE SQL_DOUBLE
112#define SQL_C_DEFAULT 99
d76fe38b
RR
113
114/*
115 * NULL status constants.
116 */
7beb59f3
WS
117#define SQL_NO_NULLS 0
118#define SQL_NULLABLE 1
119#define SQL_NULLABLE_UNKNOWN 2
d76fe38b
RR
120
121/*
122 * Special length values
123 */
7beb59f3
WS
124#define SQL_NULL_DATA (-1)
125#define SQL_DATA_AT_EXEC (-2)
126#define SQL_NTS (-3)
d76fe38b
RR
127
128/*
129 * SQLFreeStmt
130 */
7beb59f3
WS
131#define SQL_CLOSE 0
132#define SQL_DROP 1
133#define SQL_UNBIND 2
134#define SQL_RESET_PARAMS 3
d76fe38b
RR
135
136/*
137 * SQLTransact
138 */
7beb59f3
WS
139#define SQL_COMMIT 0
140#define SQL_ROLLBACK 1
d76fe38b
RR
141
142/*
143 * SQLColAttributes
144 */
7beb59f3
WS
145#define SQL_COLUMN_COUNT 0
146#define SQL_COLUMN_NAME 1
147#define SQL_COLUMN_TYPE 2
148#define SQL_COLUMN_LENGTH 3
149#define SQL_COLUMN_PRECISION 4
150#define SQL_COLUMN_SCALE 5
151#define SQL_COLUMN_DISPLAY_SIZE 6
152#define SQL_COLUMN_NULLABLE 7
153#define SQL_COLUMN_UNSIGNED 8
154#define SQL_COLUMN_MONEY 9
155#define SQL_COLUMN_UPDATABLE 10
156#define SQL_COLUMN_AUTO_INCREMENT 11
157#define SQL_COLUMN_CASE_SENSITIVE 12
158#define SQL_COLUMN_SEARCHABLE 13
159#define SQL_COLUMN_TYPE_NAME 14
160#define SQL_COLUMN_TABLE_NAME 15
161#define SQL_COLUMN_OWNER_NAME 16
162#define SQL_COLUMN_QUALIFIER_NAME 17
163#define SQL_COLUMN_LABEL 18
164
165#define SQL_COLATT_OPT_MAX SQL_COLUMN_LABEL
166#define SQL_COLATT_OPT_MIN SQL_COLUMN_COUNT
167#define SQL_COLUMN_DRIVER_START 1000
d76fe38b
RR
168
169/*
170 * SQLColAttributes : SQL_COLUMN_UPDATABLE
171 */
7beb59f3
WS
172#define SQL_ATTR_READONLY 0
173#define SQL_ATTR_WRITE 1
174#define SQL_ATTR_READWRITE_UNKNOWN 2
d76fe38b
RR
175
176/*
177 * SQLColAttributes : SQL_COLUMN_SEARCHABLE
178 */
7beb59f3
WS
179#define SQL_UNSEARCHABLE 0
180#define SQL_LIKE_ONLY 1
181#define SQL_ALL_EXCEPT_LIKE 2
182#define SQL_SEARCHABLE 3
d76fe38b
RR
183
184/*
185 * NULL Handles
186 */
7beb59f3
WS
187#define SQL_NULL_HENV 0
188#define SQL_NULL_HDBC 0
189#define SQL_NULL_HSTMT 0
d76fe38b
RR
190
191
192/*
193 * Function Prototypes
194 */
195#ifdef __cplusplus
196extern "C"
197{
198#endif
199
200 RETCODE SQL_API SQLAllocConnect (HENV henv, HDBC FAR * phdbc);
201 RETCODE SQL_API SQLAllocEnv (HENV FAR * phenv);
202 RETCODE SQL_API SQLAllocStmt (HDBC hdbc, HSTMT FAR * phstmt);
203 RETCODE SQL_API SQLBindCol (HSTMT hstmt, UWORD icol, SWORD fCType,
204 PTR rgbValue, SDWORD cbValueMax, SDWORD FAR * pcbValue);
205 RETCODE SQL_API SQLCancel (HSTMT hstmt);
206 RETCODE SQL_API SQLColAttributes (HSTMT hstmt, UWORD icol, UWORD fDescType,
207 PTR rgbDesc, SWORD cbDescMax, SWORD FAR * pcbDesc, SDWORD FAR * pfDesc);
208 RETCODE SQL_API SQLConnect (HDBC hdbc, UCHAR FAR * szDSN, SWORD cbDSN,
209 UCHAR FAR * szUID, SWORD cbUID, UCHAR FAR * szAuthStr, SWORD cbAuthStr);
210 RETCODE SQL_API SQLDescribeCol (HSTMT hstmt, UWORD icol,
211 UCHAR FAR * szColName, SWORD cbColNameMax, SWORD FAR * pcbColName,
212 SWORD FAR * pfSqlType, UDWORD FAR * pcbColDef, SWORD FAR * pibScale,
213 SWORD FAR * pfNullable);
214 RETCODE SQL_API SQLDisconnect (HDBC hdbc);
215 RETCODE SQL_API SQLError (HENV henv, HDBC hdbc, HSTMT hstmt,
216 UCHAR FAR * szSqlState, SDWORD FAR * pfNativeError, UCHAR FAR * szErrorMsg,
217 SWORD cbErrorMsgMax, SWORD FAR * pcbErrorMsg);
218 RETCODE SQL_API SQLExecDirect (HSTMT hstmt, UCHAR FAR * szSqlStr,
219 SDWORD cbSqlStr);
220 RETCODE SQL_API SQLExecute (HSTMT hstmt);
221 RETCODE SQL_API SQLFetch (HSTMT hstmt);
222 RETCODE SQL_API SQLFreeConnect (HDBC hdbc);
223 RETCODE SQL_API SQLFreeEnv (HENV henv);
224 RETCODE SQL_API SQLFreeStmt (HSTMT hstmt, UWORD fOption);
225 RETCODE SQL_API SQLGetCursorName (HSTMT hstmt, UCHAR FAR * szCursor,
226 SWORD cbCursorMax, SWORD FAR * pcbCursor);
227 RETCODE SQL_API SQLNumResultCols (HSTMT hstmt, SWORD FAR * pccol);
228 RETCODE SQL_API SQLPrepare (HSTMT hstmt, UCHAR FAR * szSqlStr,
229 SDWORD cbSqlStr);
230 RETCODE SQL_API SQLRowCount (HSTMT hstmt, SDWORD FAR * pcrow);
231 RETCODE SQL_API SQLSetCursorName (HSTMT hstmt, UCHAR FAR * szCursor,
232 SWORD cbCursor);
233 RETCODE SQL_API SQLTransact (HENV henv, HDBC hdbc, UWORD fType);
234
235/*
34621cc5 236 * Deprecated ODBC 1.0 function - Use SQLBindParameter
d76fe38b
RR
237 */
238 RETCODE SQL_API SQLSetParam (HSTMT hstmt, UWORD ipar, SWORD fCType,
239 SWORD fSqlType, UDWORD cbColDef, SWORD ibScale, PTR rgbValue,
240 SDWORD FAR * pcbValue);
241
242#ifdef __cplusplus
243}
244#endif
245
246#endif