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