19.2.1 a_rdb_SQLAllocConnect()(コネクションハンドルの割り当て)
(1) 機能
HADBサーバとのコネクションを一意に識別するためのコネクションハンドルを割り当てます。
(2) 形式
signed short a_rdb_SQLAllocConnect ( void **ConnectionHandle, /* Out */ char *ClientDefPath, /* In */ void *Option /* In */ )
(3) 引数の説明
- ConnectionHandle:
-
コネクションハンドルを設定するアドレスを指定します。
- ClientDefPath:
-
クライアント定義ファイルのパスをC言語またはC++言語の文字列表現で指定します。
NULLを指定した場合,%ADBCLTDIR%\conf\client.def※が指定されたと仮定します。
注※ Linux版のHADBクライアントの場合は,$ADBCLTDIR/conf/client.defになります。
- Option:
-
NULLを指定します。
(4) 戻り値
-
a_rdb_SQLAllocConnect()が正常に終了した場合,a_rdb_RC_SQL_SUCCESSが返却されます。
-
コネクションハンドルの割り当ては成功したが,クライアントメッセージログファイルを格納しているディスクが満杯になった場合,a_rdb_RC_SQL_WARNINGが返却されます。
-
クライアントメッセージログファイルにメッセージが出力できない場合にエラーが発生したときは,エラー要因コードが返却されます。エラー要因コードについては,「19.8 CLI関数の戻り値」を参照してください。
(5) 留意事項
次に示す場合,a_rdb_SQLAllocConnect()は実行できません。
-
不正なクライアント定義ファイルのパスを指定した場合
-
クライアント定義の指定内容に誤りがある場合
-
コネクションハンドルの割り当てに失敗した場合