19.4.11 a_rdb_SQLFreeStmt()(文ハンドルの解放)
(1) 機能
a_rdb_SQLAllocStmt()で確保した文ハンドルを解放します。
文ハンドルが解放されると,オープンしているカーソルもクローズされます。
(2) 形式
signed short a_rdb_SQLFreeStmt ( void *ConnectionHandle, /* In */ void *StatementHandle, /* In */ void *Option /* In */ )
(3) 引数の説明
- ConnectionHandle:
-
コネクションハンドルを指定します。
- StatementHandle:
-
文ハンドルを指定します。
- Option:
-
NULLを指定します。
(4) 戻り値
-
a_rdb_SQLFreeStmt()が正常に終了した場合,a_rdb_RC_SQL_SUCCESSが返却されます。
-
文ハンドルの解放には成功したが,サーバメッセージログファイルまたはクライアントメッセージログファイルを格納しているディスクが満杯になった場合,a_rdb_RC_SQL_WARNINGが返却されます。
-
クライアントメッセージログファイルにメッセージが出力できない場合にエラーが発生したときは,エラー要因コードが返却されます。エラー要因コードについては,「19.8 CLI関数の戻り値」を参照してください。
(5) 留意事項
次に示す場合,a_rdb_SQLFreeStmt()は実行できません。
-
コネクションが確立されていない場合
-
無効な文ハンドルを指定した場合
-
行の取り出し処理で発生したエラーを,文ハンドルの解放の延長で実行されたカーソルクローズで検知した場合