SQLFreeStmt
功能描述
停止与特定语句关联的处理、关闭与该语句关联的任何打开的游标、放弃挂起的结果,或者,还可以释放与该语句句柄关联的所有资源。
接口原型
RETCODE SQL_API
SQLFreeStmt(HSTMT StatementHandle,
SQLUSMALLINT Option)
参数说明
参数名 | 参数说明 |
---|---|
StatementHandle | 语句句柄。 |
Option | 操作选项。为下列之一:
|
返回
- SQL_SUCCESS:表示调用正确。
- SQL_ERROR:表示比较严重的错误,如:内存分配失败、建立连接失败等。
- SQL_INVALID_HANDLE:表示调用无效句柄。其他API的返回值同理。
其他
- SQL_CLOSE
关闭与StatementHandle关联的游标(如果定义了游标),并丢弃所有未决的结果。应用程序稍后可以使用相同或不同的参数值再次执行SELECT语句,从而重新打开这个游标。如果没有游标打开,则此选项对应用程序没有作用。也可以调用SQLCloseCursor来关闭游标。
- SQL_DROP
释放游标并丢弃任何结果信息。在释放相关游标之前,不要将语句与连接分离。否则cc cursor_count()将得到错误的结果。
- SQL_UNBIND
将ARD的SQL_DESC_COUNT字段设置为0,为给定的StatementHandle释放所有由SQLBindCol绑定的列缓冲区。这不会解除书签列的绑定;为此,将书签列的ARD的SQL_DESC_DATA_PTR字段设置为NULL。请注意,如果这个操作是在一个显式分配的描述符上执行的,并且该描述符由多个语句共享,那么这个操作将影响所有共享该描述符的语句的绑定。
- SQL_RESET_PARAMS
将APD的SQL_DESC_COUNT字段设置为0,释放由SQLBindParameter为给定的StatementHandle设置的所有参数缓冲区。如果这个操作是在一个显式分配的描述符上执行的,该描述符由多个语句共享,那么这个操作将影响所有共享该描述符的语句的绑定。