C/C++ ODBC API

来源:互联网 发布:php网页上传服务器 编辑:程序博客网 时间:2024/05/20 05:28

1. SQLAllocHandle 创建ODBC句柄

    SQLRETURN SQLAllocHandle(

         SQlSMALLINT HandleType,

         SQLHANDLE  InputHandle,

         SQLHANDLE* OutputHandlePtr

    );

     第一个参数HandleType的取值为:

               SQL_HANDLE_ENV:申请环境句柄

               SQL_HANDLE_DBC:申请数据库连接句柄

               SQL_HANDLE_STMT:申请SQL语句句柄,每次执行SQL语句都要申请语句句柄,并在执行完之后释放。

     第二个参数InputHandle为输入句柄

     第三个参数为输出句柄

     SQLAllocHandle(SQL_HANDLE_ENV,NULL,&hEnv);

    SQLSetEnvAttr(henv, SQL_ATTR_ODBC_VERSION,(SQLPOINTER)     SQL_OV_ODBC3, SQL_IS_INTEGER);

    SQLAllocHandle(SQL_HANDLE_DBC,hEnv,&hDBC);

    SQLAllocHandle(SQL_HANDLE_STMT,hDBC,&hSTMT);


  2.SQLGetDiagRec(

          SQLSMALLINT     HandleType,

          SQLHANDLE     Handle,

          SQLSMALLINT     RecNumber,

          SQLCHAR *     Sqlstate,

          SQLINTEGER *     NativeErrorPtr,

          SQLCHAR *     MessageText,

          SQLSMALLINT     BufferLength,

          SQLSMALLINT *     TextLengthPtr);

          RecNumber:指明需要得到的错误状态行,从1开始逐次增大。

          Sqlstate,NativeErrorPtr,MessageText:返回错误状态,错误代码和错误描述。

          BufferLength:指定MessageText的最大长度。

          TextLengthPtr:指定返回的MessageText中有效的字符数。

          函 数的返回值可能为:SQL_SUCCESS,SQL_SUCCESS_WITH_INFO,SQL_ERROR,SQL_INVALID_HANDLE,SQL_NO_DATA。在没             有返回错误的情况下你需要反复调用此函数,并顺次增大RecNumber参数的值,直到函数返回SQL_NO_DATA,以 得到所有的错误描述。

   3. SQLConnect 连接数据库

       SQLRETURN SQLConnect(

            SQLHDBC     ConnectionHandle,

            SQLCHAR *     ServerName,

            SQLSMALLINT     NameLength1,

            SQLCHAR *     UserName,

            SQLSMALLINT     NameLength2,

            SQLCHAR *     Authentication,

            SQLSMALLINT     NameLength3);

            ConnectionHanlde:为DBC句柄,也就是前面提到到利用:

            SQLAllocHandle(SQL_HANDLE_DBC,hEnv,&hDBC);申请的句柄。

            ServerName:为ODBC的DSN名称。

            NameLength1:指明参数ServerName数据的长度。

            UserName:数据库用户名。

            NameLength2:指明参数UserName数据的长度。

            Authentication:数据库用户密码。

            NameLength3:指明参数Authentication数据的长度。

            关于ServerName,UserName,Authentication参数长度可以直接指定也可以指定为SQL_NTS表明参数是以NULL字符结尾。

4. SQLExecDirect 直接执行SQL语句

         SQLRETURN SQLExecDirect(

              SQLHSTMT     StatementHandle,

              SQLCHAR *     StatementText,

              SQLINTEGER     TextLength);

              StatementHandle:SQL语句句柄,也就是前面提到的利用:

              SQLAllocHandle(SQL_HANDLE_STMT,hDBC,&hSTMT);申请的句柄。

              StatementText:SQL语句。

              TextLength:参数StatementText的长度,可以使用SQL_NTS表示字符串以NULL字符结尾。

              如果函数执行成功,你将会得到一个结果集,否则将返回错误信息。

              SQLExecDirect函数除可以执行 Select 语句外,还可以执行Insert,Update,Delete 语句,在执行修改SQL语句后可以利用SQLRowCount                   函数来得到被更新的记录的数量。

 

5.    SQLGetData 得到光标处的某列的值

            SQLRETURN SQLGetData(

                 SQLHSTMT     StatementHandle,

                 SQLUSMALLINT     ColumnNumber,

                 SQLSMALLINT     TargetType,

                 SQLPOINTER     TargetValuePtr,

                 SQLINTEGER     BufferLength,

                 SQLINTEGER *     StrLen_or_IndPtr);

                 StatementHanlde:STMT句柄。

                 ClumnNumber:列号,以1开始。

                 TargetType:数据缓冲区(TargetValuePtr)的C语言数据类型,请参照图2.6。

                 BufferLength:数据缓冲区(TargetValuePtr)的长度。

                 StrLen_or_IndPtr:返回当前得到的字段的字节长度。

6.     SQLNumResultCols 得到结果集中列数

        SQLRETURN SQLNumResultCols(

              SQLHSTMT     StatementHandle,

              SQLSMALLINT *     ColumnCountPtr);

              StatementHandle:STMT句柄

              ColumnCountPtr:返回列数

7.     SQLDescribeCol 得到结果集中列的描述

        SQLRETURN SQLDescribeCol(

              SQLHSTMT     StatementHandle,

              SQLSMALLINT     ColumnNumber,

              SQLCHAR *     ColumnName,

              SQLSMALLINT     BufferLength,

              SQLSMALLINT *     NameLengthPtr,

              SQLSMALLINT *     DataTypePtr,

              SQLUINTEGER *     ColumnSizePtr,

              SQLSMALLINT *     DecimalDigitsPtr,

              SQLSMALLINT *     NullablePtr);

              StatementHandle:STMT句柄。

              ColumnNumber:需要得到的列的序号,从1开始计算。

              ColumnName:得到列的名称。

              BufferLength:指明ColumnName参数的最大长度。

              NameLengthPtr:返回列名称的长度。

              DataTypePtr:得到列的ODBC数据类型

              ColumnSizePtr:得到列的长度。

              DecimalDigitsPtr:当该列为数字类型时返回小数点后数据的位数。

              NullablePtr:指明该列是否允许为空值。


8.     SQLRowCount 执行SQL语句后得到影响的行数

             SQLRETURN SQLRowCount(

             SQLHSTMT     StatementHandle,

             SQLINTEGER *     RowCountPtr);

             你可以通过SQLExecDirect执行SQL语句来插入,修改和删除数据,在执行插入,修改和删除的SQL语句后就可以通过SQLRowCount函数来                得到被影响的数据的行数。


9.   SQLSetConnectAttr 通过调用 SQLSetConnectAttr    在数据库连接建立或建立后设置连接的一些属性。

      SQLRETURN SQLSetConnectAttr(

           SQLHDBC     ConnectionHandle,

           SQLINTEGER     Attribute,

           SQLPOINTER     ValuePtr,

           SQLINTEGER     StringLength);

           ConnectionHandle:提供DBC连接句柄。

           Attribute:指定需要设置的属性类型,在这里设置为值SQL_ATTR_AUTOCOMMIT。

           ValuePtr:提供参数值。

           StringLength:指定参数的长度,当参数为整数是设置为SQL_IS_INTEGER,当参数为字符串时设置为字符串长度或者为SQL_NTS     。

           这里讲一下常用的参数Attribute可能的取值和ValuePtr对应的取值:

Attribute

ValuePtr

作用

SQL_ATTR_CONNECTION_DEAD

提供一个合法的SQLINTEGER           指针作为输出参数

检查连接是否已经断开

返回:SQL_CD_TRUE表明连接已经断开,

SQL_CD_FALSE表明连接还保持。

SQL_ATTR_CONNECTION_TIMEOUT

设置一个合法的整数

建立与数据库连接时最大等待的超时秒数,ValuePtr设置为0表明不使用超时控制。

SQL_ATTR_LOGIN_TIMEOUT

设置一个合法的整数

建立与数据库用户登录时最大等待的超时秒数,ValuePtr设置为0表明不使用超时控制。

SQL_ATTR_TRACE

整数,取值为:SQL_OPT_TRACE_OFF,SQL_OPT_TRACE_ON

设置是否跟踪ODBC驱动程序中函数的调用。

SQL_ATTR_TRACEFILE

设置一个合法的文件名字符串,表明记录跟踪记录的文件名。

设置记录函数调用的文件名称。


10.  SQLSetStmtAttr语句句柄设置参数

       SQLRETURN SQLSetStmtAttr(

           SQLHSTMT     StatementHandle,

           SQLINTEGER     Attribute,

           SQLPOINTER     ValuePtr,

           SQLINTEGER     StringLength);

           ConnectionHandle:提供STMT连接句柄。

           Attribute:指定需要设置的属性类型,在这里设置为值SQL_ATTR_AUTOCOMMIT。

           ValuePtr:提供参数值。

          StringLength:指定参数的长度,当参数为整数是设置为SQL_IS_INTEGER,当参数为字符串时设置为字符串长度或者为SQL_NTS     。

常用的参数Attribute可能的取值和ValuePtr对应的取值:

Attribute

ValuePtr

作用

SQL_ATTR_ASYNC_ENABLE

整数,取值为:SQL_ASYNC_ENABLE_OFF,SQL_ASYNC_ENABLE_ON

是否使用异步执行功能

SQL_ATTR_QUERY_TIMEOUT

设置一个合法的整数

SQL语句执行时的超时秒数,设置为0表示无超时

SQL_ATTR_CURSOR_TYPE

整数,取值为:SQL_CURSOR_FORWARD_ONLY,SQL_CURSOR_STATIC,SQL_CURSOR_DYNAMIC,SQL_CURSOR_KEYSET_DRIVEN

设置光标的类型


11. SQLFetchScroll使光标能够前后移动

     SQLRETURN SQLFetchScroll(

          SQLHSTMT     StatementHandle,

          SQLSMALLINT     FetchOrientation,

          SQLINTEGER     FetchOffset);

          与SQLFetch不同的是多了后面两个参数。

          FetchOrientation:表明滚动的方式,允许的值如下:

FetchOrientation

含义

SQL_FETCH_NEXT

滚动到下一行,这时候调用相当与SQLFetch,参数FetchOffset将被忽略

SQL_FETCH_PRIOR

滚动到上一行,参数FetchOffset将被忽略

SQL_FETCH_FIRST

滚动到第一行,参数FetchOffset将被忽略

SQL_FETCH_LAST

滚动到最后一行,参数FetchOffset将被忽略

SQL_FETCH_ABSOLUTE

滚动到参数FetchOffset指定的绝对行

SQL_FETCH_RELATIVE

由当前位置滚动到参数FetchOffset指定的相对行,FetchOffset大于0表示向前滚动,FetchOffset小于0表示向后滚动

         FetchOffset:表明光标滚动的位置。

         光标滚动后,获取数据的方法和SQLFetch相同。滚动时如果指定的位置超出结果集区域会返回错误。


12.  SQLBindParameter绑定参数

       SQLRETURN SQLBindParameter(

            SQLHSTMT     StatementHandle,

           SQLUSMALLINT     ParameterNumber,

           SQLSMALLINT     InputOutputType,

           SQLSMALLINT     ValueType,

           SQLSMALLINT     ParameterType,

           SQLUINTEGER     ColumnSize,

           SQLSMALLINT     DecimalDigits,

           SQLPOINTER     ParameterValuePtr,

           SQLINTEGER     BufferLength,

           SQLINTEGER *     StrLen_or_IndPtr);

           StatementHandle:执行SQL语句STMT句柄。

           ParameterNumber:指明要将变量与第几个参数绑定,从1开始计算。

           InputOutputType:指明是输入还是输出参数。可以取值的范围为:SQL_PARAM_INPUT,SQL_PARAM_OUTPUT ,                           SQL_PARAM_INPUT_OUTPUT。

           ValueType:指明用于和参数绑定的C语言数据类型。

           ParameterType:指明在存储过程中ODBC数据类型。

           ColumnSize:指明接收数据的宽度,对于字符串和结构需要指明数据的宽度,而对于普通的变量如SQLINTEGER,SQLFLOAT等设置为0就可以了。

           DecimalDigits :当数据类型为SQL_NUMERIC,SQL_DECIMAL时指明数字小数点的精度,否则填0。

           ParameterValuePtr:在作为输入参数指明参数的指针,在作为输出参数时指明接收数据的变量指针。

           BufferLength:指明参数指针所指向的缓冲区的字节数大小。对于字符串和结构需要指明大小,而对于普通的变量如SQLINTEGER,SQLFLOAT等设置为0就可以了。

           StrLen_or_IndPtr: 作为输入参数时指明数据的字节数大小,对于普通的定长变量如SQLINTEGER,SQLFLOAT等设置为0就可以了,对于字符号串需要在此参数中指定 字符串数据的长度,或者设置为SQL_NULL_DATA表明此参数为空值,或者设置为SQL_NTS表明字符串以NULL字符结尾,对于结构需要指明结 构的长度。当作为输出参数时,当SQL执行完毕后会在这个参数中返回拷贝的缓冲区的数据的字节数。

13. SQLPrepare准备需要执行的SQL语句:

      SQLRETURN SQLPrepare(

           SQLHSTMT     StatementHandle,

           SQLCHAR *     StatementText,

           SQLINTEGER     TextLength);

           StatementHandle:STMT句柄。

           StatementText:包含SQL语句的字符串。

           TextLength:SQL语句的长度,或者使用SQL_NTS 表示SQL语句以NULL字符结尾。


14. SQLRETURN SQLExecute 执行经过准备的SQL语句

      SQLRETURN SQLExecute(SQLHSTMT  StatementHandle);

      在执行SQL语句时可以利用SQLPrepare 和SQLExecute 的组合来代替SQLExecDirect函数。

      使 用SQLExecute执行和SQLExecDirect执行后的STMT句柄可以进行相同的操作,例如使用SQLFetch取得结果集。不过准备-执行模式一般用来执行各种大批量的数据修改,而不是用来执行查 询语句。此外对于那些需要反复执行的SQL语句利用准备-执行模式会比反复执行SQLExecDirect速度快。当执行数据修改时可以采用前面提到过的参数绑定,并且每执行一次重新后修改参数的值。


15. SQLGetData列绑定出参 

     SQLRETURN SQLBindCol(

          SQLHSTMT     StatementHandle,

          SQLUSMALLINT     ColumnNumber,

          SQLSMALLINT     TargetType,

          SQLPOINTER     TargetValuePtr,

          SQLINTEGER     BufferLength,

          SQLLEN *     StrLen_or_Ind);

          StatementHandle:STMT句柄。

          ColumnNumber:列的位置,从1开始计算。

          ValueType:指明用于和参数绑定的C语言数据类型。

          ParameterType:指明在存储过程中ODBC数据类型。

          BufferLength:指明参数指针所指向的缓冲区的字节数大小。对于字符串和结构需要指明大小,而对于普通的变量如SQLINTEGER,       SQLFLOAT等设置为0就可以了。

          StrLen_or_IndPtr:返回拷贝的缓冲区的数据的字节数。

16. SQLRETURN SQLParamData(

           SQLHSTMT     StatementHandle,

           SQLPOINTER *     ValuePtrPtr);

           StatementHandle:指定STMT句柄,检查在此句柄上执行的SQL语句是否需要提供参数。

           ValuePtrPtr:得到调用SQLBindParameter时指定的参数数据指针。


17.  SQLRETURN SQLPutData(

            SQLHSTMT     StatementHandle,

            SQLPOINTER     DataPtr,

            SQLINTEGER     StrLen_or_Ind);

            StatementHandle:指定STMT句柄。

            ValuePtrPtr:指明数据区地址。

            StrLen_or_Ind:指明本次提供的数据的大小。


在插入和更新大数据时,可以按照下面的顺序来进行:

l              调用SQLPrepare准备SQL语句,需要插入或修改的列也必须以参数的形式出现在SQL语句中。

l              调用SQLBindParameter 绑定参数,并将参数长度设置为:SQL_LEN_DATA_AT_EXEC(length)。

l              调用SQLExecute 执行已经准备好的语句,调用应该返回:SQL_NEED_DATA,表明需要提供参数数据。

l              调用SQLParamData 检查是否需要为SQL语句提供参数,调用应该返回:SQL_NEED_DATA。

l              循环提供数据时调用SQLPutData 来提供数据,此时每次提供的数据量不能超过调用SQLBindParameter 时设置的数据长度。

l              再次调用SQLParamData ,表明本次参数的所有数据都已经传递完毕,并且检查是否还有下一个参数需要提供数据,如果有返回上一步提供数据。


18. SQLSetConnectAttr自动提交事务模式

      SQLRETURN SQLSetConnectAttr(

           SQLHDBC     ConnectionHandle,

           SQLINTEGER     Attribute,

           SQLPOINTER     ValuePtr,

           SQLINTEGER     StringLength);

           ConnectionHandle:提供DBC连接句柄。

           Attribute:指定需要设置的属性类型,在这里设置为值SQL_ATTR_AUTOCOMMIT,需要强制转换位指针类型。

          ValuePtr:提供参数值。

          StringLength:指定参数的长度,当参数为整数是设置为SQL_IS_INTEGER,当参数为字符串时设置为字符串长度或者为SQL_NTS     。

19. 手工提交事务模式

        SQLRETURN SQLEndTran(

             SQLSMALLINT     HandleType,

             SQLHANDLE     Handle,

            SQLSMALLINT     CompletionType);

            HandleType:指定句柄的类型,设置为值:SQL_HANDLE_DBC。

            Handle:提供DBC连接句柄。

            CompletionType:设置为SQL_COMMIT或者SQL_ROLLBACK表明提交或者回滚。


20 。SQLRETURN SQLCancel( SQLHSTMT     StatementHandle);取消语句执行

原创粉丝点击