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