19.4.14 a_rdb_SQLPrepare()(SQL文の前処理)
(1) 機能
SQL文の前処理を実行します。前処理できるSQL文を次に示します。
-
DELETE文
-
INSERT文
-
PURGE CHUNK文
-
TRUNCATE TABLE文
-
SELECT文
-
UPDATE文
-
定義系SQL
a_rdb_SQLPrepare()を実行すると,指定したSQL文が実行可能な状態に前処理され,文ハンドルにそのSQL文が割り当てられます。
(2) 形式
signed short a_rdb_SQLPrepare ( void *ConnectionHandle, /* In */ void *StatementHandle, /* In */ char *StatementText, /* In */ void *Option /* In */ )
(3) 引数の説明
- ConnectionHandle:
-
コネクションハンドルを指定します。
- StatementHandle:
-
文ハンドルを指定します。
- StatementText:
-
前処理を実行するSQL文のテキストをC言語またはC++言語の文字列表現で指定します。
- Option:
-
NULLを指定します。
(4) 戻り値
-
a_rdb_SQLPrepare()が正常に終了した場合,a_rdb_RC_SQL_SUCCESSが返却されます。
-
SQL文の前処理には成功したが,サーバメッセージログファイルまたはクライアントメッセージログファイルを格納しているディスクが満杯になった場合,a_rdb_RC_SQL_WARNINGが返却されます。
-
クライアントメッセージログファイルにメッセージが出力できない場合にエラーが発生したときは,エラー要因コードが返却されます。エラー要因コードについては,「19.8 CLI関数の戻り値」を参照してください。
(5) 留意事項
次に示す場合,a_rdb_SQLPrepare()は実行できません。
-
コネクションが確立されていない場合
-
無効な文ハンドルを指定した場合