19.4.5　a_rdb_SQLCloseCursor()（カーソルのクローズ）

(1)　機能

カーソルをクローズして，行の取り出しを終了します。

行を取り出している最中の処理リアルスレッドがある場合，その処理リアルスレッドを終了します。

ページの先頭へ

(2)　形式

signed short a_rdb_SQLCloseCursor
(
  void                          *ConnectionHandle,   /* In */
  void                          *StatementHandle,    /* In */
  void                          *Option              /* In */
)

ページの先頭へ

(3)　引数の説明

ConnectionHandle：

コネクションハンドルを指定します。

StatementHandle：

文ハンドルを指定します。

Option：

NULLを指定します。

ページの先頭へ

(4)　戻り値

1. a_rdb_SQLCloseCursor()が正常に終了した場合，a_rdb_RC_SQL_SUCCESSが返却されます。

2. カーソルのクローズには成功したが，サーバメッセージログファイルまたはクライアントメッセージログファイルを格納しているディスクが満杯になった場合，a_rdb_RC_SQL_WARNINGが返却されます。

3. クライアントメッセージログファイルにメッセージが出力できない場合にエラーが発生したときは，エラー要因コードが返却されます。エラー要因コードについては，「19.8　CLI関数の戻り値」を参照してください。

ページの先頭へ

(5)　留意事項

1. 次に示す場合，a_rdb_SQLCloseCursor()は実行できません。

   • コネクションが確立されていない場合

   • 無効な文ハンドルを指定した場合

   • 行の取り出し処理で発生したエラーを，カーソルクローズで検知した場合

2. トランザクションが終了した場合，その時点でオープンしているカーソルはすべてクローズされます。また，暗黙的にデータベースへの更新が無効にされた場合にも，カーソルはすべてクローズされます。なお，暗黙的にデータベースへの更新が無効にされた場合，サーバメッセージログファイルおよびクライアントメッセージログファイルに，KFAA51001-EまたはKFAA51002-Eメッセージが出力されます。

ページの先頭へ