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