src/iodbc/isql.h

   1 /*
   2  *  isql.h
   3  *
   4  *  $Id$
   5  *
   6  *  iODBC defines
   7  *
   8  *  The iODBC driver manager.
   9  *
  10  *  Copyright (C) 1995 by Ke Jin <kejin@empress.com>
  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
  29 #ifdef WIN32
  30 #define SQL_API                         __stdcall
  31 #else
  32 #define FAR
  33 #define EXPORT
  34 #define CALLBACK
  35 #define SQL_API                         EXPORT CALLBACK
  36
  37 typedef void *HWND;
  38 #endif
  39
  40 typedef void *SQLHWND;
  41
  42 typedef unsigned char UCHAR;
  43 typedef long int SDWORD;
  44 typedef short int SWORD;
  45 typedef unsigned long int UDWORD;
  46 typedef unsigned short int UWORD;
  47
  48 typedef void FAR *PTR;
  49 typedef void FAR *HENV;
  50 typedef void FAR *HDBC;
  51 typedef void FAR *HSTMT;
  52
  53 typedef signed short RETCODE;
  54 #define SQLRETURN       RETCODE
  55
  56
  57 #define ODBCVER                         0x0250
  58
  59 #define SQL_MAX_MESSAGE_LENGTH          512
  60 #define SQL_MAX_DSN_LENGTH              32
  61
  62 /*
  63  *  Function return codes
  64  */
  65 #define SQL_INVALID_HANDLE              (-2)
  66 #define SQL_ERROR                       (-1)
  67 #define SQL_SUCCESS                     0
  68 #define SQL_SUCCESS_WITH_INFO           1
  69 #define SQL_NO_DATA_FOUND               100
  70
  71 /*
  72  *  Standard SQL datatypes, using ANSI type numbering
  73  */
  74 #define SQL_CHAR                        1
  75 #define SQL_NUMERIC                     2
  76 #define SQL_DECIMAL                     3
  77 #define SQL_INTEGER                     4
  78 #define SQL_SMALLINT                    5
  79 #define SQL_FLOAT                       6
  80 #define SQL_REAL                        7
  81 #define SQL_DOUBLE                      8
  82 #define SQL_VARCHAR                     12
  83
  84 #define SQL_TYPE_MIN                    SQL_CHAR
  85 #define SQL_TYPE_NULL                   0
  86 #define SQL_TYPE_MAX                    SQL_VARCHAR
  87
  88 /*
  89  *  C datatype to SQL datatype mapping
  90  */
  91 #define SQL_C_CHAR                      SQL_CHAR
  92 #define SQL_C_LONG                      SQL_INTEGER
  93 #define SQL_C_SHORT                     SQL_SMALLINT
  94 #define SQL_C_FLOAT                     SQL_REAL
  95 #define SQL_C_DOUBLE                    SQL_DOUBLE
  96 #define SQL_C_DEFAULT                   99
  97
  98 /*
  99  *  NULL status constants.
 100  */
 101 #define SQL_NO_NULLS                    0
 102 #define SQL_NULLABLE                    1
 103 #define SQL_NULLABLE_UNKNOWN            2
 104
 105 /*
 106  *  Special length values
 107  */
 108 #define SQL_NULL_DATA                   (-1)
 109 #define SQL_DATA_AT_EXEC                (-2)
 110 #define SQL_NTS                         (-3)
 111
 112 /*
 113  *  SQLFreeStmt
 114  */
 115 #define SQL_CLOSE                       0
 116 #define SQL_DROP                        1
 117 #define SQL_UNBIND                      2
 118 #define SQL_RESET_PARAMS                3
 119
 120 /*
 121  *  SQLTransact
 122  */
 123 #define SQL_COMMIT                      0
 124 #define SQL_ROLLBACK                    1
 125
 126 /*
 127  *  SQLColAttributes
 128  */
 129 #define SQL_COLUMN_COUNT                0
 130 #define SQL_COLUMN_NAME                 1
 131 #define SQL_COLUMN_TYPE                 2
 132 #define SQL_COLUMN_LENGTH               3
 133 #define SQL_COLUMN_PRECISION            4
 134 #define SQL_COLUMN_SCALE                5
 135 #define SQL_COLUMN_DISPLAY_SIZE         6
 136 #define SQL_COLUMN_NULLABLE             7
 137 #define SQL_COLUMN_UNSIGNED             8
 138 #define SQL_COLUMN_MONEY                9
 139 #define SQL_COLUMN_UPDATABLE            10
 140 #define SQL_COLUMN_AUTO_INCREMENT       11
 141 #define SQL_COLUMN_CASE_SENSITIVE       12
 142 #define SQL_COLUMN_SEARCHABLE           13
 143 #define SQL_COLUMN_TYPE_NAME            14
 144 #define SQL_COLUMN_TABLE_NAME           15
 145 #define SQL_COLUMN_OWNER_NAME           16
 146 #define SQL_COLUMN_QUALIFIER_NAME       17
 147 #define SQL_COLUMN_LABEL                18
 148
 149 #define SQL_COLATT_OPT_MAX              SQL_COLUMN_LABEL
 150 #define SQL_COLATT_OPT_MIN              SQL_COLUMN_COUNT
 151 #define SQL_COLUMN_DRIVER_START         1000
 152
 153 /*
 154  *  SQLColAttributes : SQL_COLUMN_UPDATABLE
 155  */
 156 #define SQL_ATTR_READONLY               0
 157 #define SQL_ATTR_WRITE                  1
 158 #define SQL_ATTR_READWRITE_UNKNOWN      2
 159
 160 /*
 161  *  SQLColAttributes : SQL_COLUMN_SEARCHABLE
 162  */
 163 #define SQL_UNSEARCHABLE                0
 164 #define SQL_LIKE_ONLY                   1
 165 #define SQL_ALL_EXCEPT_LIKE             2
 166 #define SQL_SEARCHABLE                  3
 167
 168 /*
 169  *  NULL Handles
 170  */
 171 #define SQL_NULL_HENV                   0
 172 #define SQL_NULL_HDBC                   0
 173 #define SQL_NULL_HSTMT                  0
 174
 175
 176 /*
 177  *  Function Prototypes
 178  */
 179 #ifdef __cplusplus
 180 extern "C"
 181 {
 182 #endif
 183
 184   RETCODE SQL_API SQLAllocConnect (HENV henv, HDBC FAR * phdbc);
 185   RETCODE SQL_API SQLAllocEnv (HENV FAR * phenv);
 186   RETCODE SQL_API SQLAllocStmt (HDBC hdbc, HSTMT FAR * phstmt);
 187   RETCODE SQL_API SQLBindCol (HSTMT hstmt, UWORD icol, SWORD fCType,
 188       PTR rgbValue, SDWORD cbValueMax, SDWORD FAR * pcbValue);
 189   RETCODE SQL_API SQLCancel (HSTMT hstmt);
 190   RETCODE SQL_API SQLColAttributes (HSTMT hstmt, UWORD icol, UWORD fDescType,
 191       PTR rgbDesc, SWORD cbDescMax, SWORD FAR * pcbDesc, SDWORD FAR * pfDesc);
 192   RETCODE SQL_API SQLConnect (HDBC hdbc, UCHAR FAR * szDSN, SWORD cbDSN,
 193       UCHAR FAR * szUID, SWORD cbUID, UCHAR FAR * szAuthStr, SWORD cbAuthStr);
 194   RETCODE SQL_API SQLDescribeCol (HSTMT hstmt, UWORD icol,
 195       UCHAR FAR * szColName, SWORD cbColNameMax, SWORD FAR * pcbColName,
 196       SWORD FAR * pfSqlType, UDWORD FAR * pcbColDef, SWORD FAR * pibScale,
 197       SWORD FAR * pfNullable);
 198   RETCODE SQL_API SQLDisconnect (HDBC hdbc);
 199   RETCODE SQL_API SQLError (HENV henv, HDBC hdbc, HSTMT hstmt,
 200       UCHAR FAR * szSqlState, SDWORD FAR * pfNativeError, UCHAR FAR * szErrorMsg,
 201       SWORD cbErrorMsgMax, SWORD FAR * pcbErrorMsg);
 202   RETCODE SQL_API SQLExecDirect (HSTMT hstmt, UCHAR FAR * szSqlStr,
 203       SDWORD cbSqlStr);
 204   RETCODE SQL_API SQLExecute (HSTMT hstmt);
 205   RETCODE SQL_API SQLFetch (HSTMT hstmt);
 206   RETCODE SQL_API SQLFreeConnect (HDBC hdbc);
 207   RETCODE SQL_API SQLFreeEnv (HENV henv);
 208   RETCODE SQL_API SQLFreeStmt (HSTMT hstmt, UWORD fOption);
 209   RETCODE SQL_API SQLGetCursorName (HSTMT hstmt, UCHAR FAR * szCursor,
 210       SWORD cbCursorMax, SWORD FAR * pcbCursor);
 211   RETCODE SQL_API SQLNumResultCols (HSTMT hstmt, SWORD FAR * pccol);
 212   RETCODE SQL_API SQLPrepare (HSTMT hstmt, UCHAR FAR * szSqlStr,
 213       SDWORD cbSqlStr);
 214   RETCODE SQL_API SQLRowCount (HSTMT hstmt, SDWORD FAR * pcrow);
 215   RETCODE SQL_API SQLSetCursorName (HSTMT hstmt, UCHAR FAR * szCursor,
 216       SWORD cbCursor);
 217   RETCODE SQL_API SQLTransact (HENV henv, HDBC hdbc, UWORD fType);
 218
 219 /*
 220  *  Depreciated ODBC 1.0 function - Use SQLBindParameter
 221  */
 222   RETCODE SQL_API SQLSetParam (HSTMT hstmt, UWORD ipar, SWORD fCType,
 223       SWORD fSqlType, UDWORD cbColDef, SWORD ibScale, PTR rgbValue,
 224       SDWORD FAR * pcbValue);
 225
 226 #ifdef __cplusplus
 227 }
 228 #endif
 229
 230 #endif