CLI の手引きおよび解説書

DB2 CLI 関数の要約

ODBC 列の Depr は、 ODBC 内で使用すべきでない関数を示しています。詳しくはバージョン 5 で使用すべきでない DB2 CLI 関数を参照してください。

SQL/CLI 列には、以下の値が入ります。


表 12. カテゴリー別の DB2 CLI 関数リスト

タスク関数名

ODBC 3.0 SQL/CLI
サポートされる
DB2 CLI の
最初のバージョン

目的
データ・ソースへの接続
SQLAllocEnv Depr 95 V 1.1 環境ハンドルを獲得します。 1 つまたは複数の接続に 1 つの環境ハンドルが使用されます。
SQLAllocConnect Depr 95 V 1.1 接続ハンドルを獲得します。
SQLAllocHandle() コア 95 V 5 ハンドルを獲得します。
SQLBrowseConnect() レベル 1 95 V 5 データ・ソースに接続するのに必要な属性を獲得します。
SQLConnect() コア 95 V 1.1 データ・ソース、ユーザー ID、およびパスワードによって特定のドライバーに接続します。
SQLDriverConnect() コア SQL3 V 2.1 a 接続ストリングで特定のドライバーに接続するか、または任意選択でドライバー・マネージャーとドライバーがユーザー用の接続ダイアログを表示するよう要求します。

注:この関数は、ODBC.INI ファイルでサポートされる追加の IBM キーワードの影響も受けます。

SQLDrivers() コア なし なし DB2 CLI は、この関数がドライバー・マネージャーによって実装されているため、この関数をサポートしません。
SQLSetConnectAttr() コア 95 V 5 接続属性を設定します。
SQLSetConnectOption() Depr 95 V 2.1 接続属性を設定します。
SQLSetConnection() なし SQL3 V 2.1 現行の活動状態の接続を設定します。この関数は、複数の並行接続がある DB2 CLI アプリケーションで組み込み SQL を使用するときだけ使用する必要があります。
DataLink 関数
SQLBuildDataLink() なし あり V 5.2 DATALINK 値を作成します。
SQLGetDataLinkAttr() なし あり V 5.2 DataLink 属性値を取得します。
ドライバーおよびデータ・ソースに関する情報の獲得
SQLDataSources レベル 2 95 V 1.1 使用可能なデータ・ソースのリストを返します。
SQLGetInfo() コア 95 V 1.1 特定のドライバーおよびデータ・ソースに関する情報を返します。
SQLGetFunctions() コア 95 V 1.1 サポートされているドライバー関数を返します。
SQLGetTypeInfo() コア 95 V 1.1 サポートされているデータ・タイプに関する情報を返します。
ドライバー・オプションの設定および取り出し
SQLSetEnvAttr() コア 95 V 2.1 環境オプションを設定します。
SQLGetEnvAttr() コア 95 V 2.1 環境オプションの値を返します。
SQLSetConnectOption() レベル 1 あり V 2.1 a 接続オプションを設定します。
SQLGetConnectAttr() レベル 1 95 V 5 接続オプションの値を返します。
SQLGetConnectOption() Depr 95 V 2.1 a 接続オプションの値を返します。
SQLSetStmtAttr() コア 95 V 5 ステートメント属性を設定します。
SQLSetStmtOption() Depr 95 V 2.1 a ステートメント・オプションを設定します。
SQLGetStmtAttr() コア 95 V 5 ステートメント属性の値を返します。
SQLGetStmtOption() Depr 95 V 2.1 a ステートメント・オプションの値を返します。
SQL 要求の準備
SQLAllocStmt() Depr 95 V 1.1 ステートメント・ハンドルを割り振ります。
SQLPrepare() コア 95 V 1.1 後で実行するための SQL ステートメントを準備します。
SQLExtendedPrepare() なし なし V 6 その後の実行のために SQL ステートメントのステートメント属性の配列を準備します。
SQLExtendedBind() なし なし V 6 SQLBindCol() および SQLBindParameter() を繰り返し呼び出す代わりに、列の配列をバインドします。
SQLBindParameter() レベル 1 95 b V 2.1 SQL ステートメントのパラメーター用の記憶域を割り当てます (ODBC 2.0)。
SQLSetParam() Depr なし V 1.1 SQL ステートメントのパラメーター用の記憶域を割り当てます (ODBC 1.0)。

注:ODBC 2.0 では、この関数の代わりに SQLBindParameter() が用いられます。

SQLParamOptions() Depr なし V 2.1 パラメーター用の複数の値の使用を指定します。
SQLGetCursorName() コア 95 V 1.1 ステートメント・ハンドルに関連したカーソル名を返します。
SQLSetCursorName() コア 95 V 1.1 カーソル名を指定します。
要求の実行依頼
SQLDescribeParam() レベル 2 SQL3 V 5 パラメーター・マーカーの記述を返します。
SQLExecute() コア 95 V 1.1 準備済みステートメントを実行します。
SQLExecDirect() コア 95 V 1.1 ステートメントを実行します。
SQLNativeSql() レベル 2 95 V 2.1 a ドライバーによって変換された SQL ステートメントのテキストを返します。
SQLNumParams() レベル 2 95 V 2.1 a ステートメント内のパラメーターの数を返します。
SQLParamData() レベル 1 95 V 2.1 a SQLPutData() と組み合わせて使用され、実行時にパラメーター・データを渡します。 (長いデータ値の場合に便利です。)
SQLPutData() コア 95 V 2.1 a パラメーターのデータ値の一部または全部を送ります。 (長いデータ値の場合に便利です。)
結果および結果に関する情報の取り出し
SQLRowCount() コア 95 V 1.1 挿入、更新、または削除の要求によって影響を受ける行の数を返します。
SQLNumResultCols() コア 95 V 1.1 結果セット内の列の数を返します。
SQLDescribeCol() コア 95 V 1.1 結果セット内の列について記述します。
SQLColAttribute() コア あり V 5 結果セット内の列の属性を記述します。
SQLColAttributes() Depr あり V 1.1 結果セット内の列の属性を記述します。
SQLColumnPrivileges() レベル 2 95 V 2.1 表の列に関連した特権を獲得します。
SQLSetColAttributes() なし なし V 2.1 結果セット内の列の属性を設定します。
SQLBindCol() コア 95 V 1.1 結果列のための記憶域を割り当て、データ・タイプを指定します。
SQLFetch() コア 95 V 1.1 結果行を返します。
SQLFetchScroll() コア 95 V 5 結果行から行セットを返します。
SQLExtendedFetch() Depr 95 V 2.1 複数の結果行を返します。
SQLGetData() コア 95 V 1.1 結果セットの 1 行の 1 列の一部または全部を返します。 (長いデータ値の場合に便利です。)
SQLMoreResults() レベル 1 SQL3 V 2.1 a 使用可能な結果セットがまだ残っているかどうかを判別し、もし残っていれば、次の結果セットの処理を開始します。
SQLError() Depr 95 V 1.1 追加のエラー情報または状況情報を返します。
SQLGetDiagField() コア 95 V 5 診断データのフィールドを獲得します。
SQLGetDiagRec() コア 95 V 5 診断データの複数のフィールドを獲得します。
SQLSetPos() レベル 1 SQL3 V 5 行セット内のカーソル位置を設定します。
SQLGetSQLCA() なし なし V 2.1 ステートメント・ハンドルに関連した SQLCA を返します。
SQLBulkOperations() レベル 1 なし V 6 ブックマークを使用して大量の追加、更新、削除、および取り出しを実行します。
記述子
SQLCopyDesc() コア 95 V 5 記述子情報をハンドル間でコピーします。
SQLGetDescField() コア 95 V 5 記述子レコードの単一のフィールド設定を獲得します。
SQLGetDescRec() コア 95 V 5 記述子レコードの複数のフィールド設定を獲得します。
SQLSetDescField() コア 95 V 5 記述子レコードの単一のフィールドを設定します。
SQLSetDescRec() コア 95 V 5 記述子レコードの複数のフィールド設定を設定します。
ラージ・オブジェクトのサポート
SQLBindFileToCol() なし なし V 2.1 LOB ファイル参照を LOB 列に関連付けます。
SQLBindFileToParam() なし なし V 2.1 LOB ファイル参照をパラメーター・ マーカーに関連付けます。
SQLGetLength() なし SQL3 V 2.1 LOB ロケーターで参照されるストリングの長さを取得します。
SQLGetPosition() なし SQL3 V 2.1 LOB ロケーターで参照されるソース・ ストリング内のストリングの位置を入手します。
SQLGetSubString() なし SQL3 V 2.1 ソース・ストリング内のサブストリングを参照する新しい LOB ロケーターを作成します (ソース・ストリングも LOB ロケーターで参照される)。
データ・ソースのシステム表に関する情報の獲得 (カタログ関数)
SQLColumns() レベル 1 SQL3 V 2.1 a 指定した表の中の列名のリストを返します。
SQLForeignKeys() レベル 2 SQL3 V 2.1 指定した表の外部キーがある場合には、外部キーを構成する列名のリストを返します。
SQLPrimaryKeys() レベル 1 SQL3 V 2.1 表の基本キーを構成する列名のリストを返します。
SQLProcedureColumns() レベル 2 なし V 2.1 指定したプロシージャーの入力パラメーターおよび出力パラメーターのリストを返します。
SQLProcedures() レベル 2 なし V 2.1 特定のデータ・ソースに保管されたプロシージャー名のリストを返します。
SQLSpecialColumns() コア SQL3 V 2.1 a 指定した表の行を固有に識別する最適な列の集まりに関する情報を返します。
SQLStatistics() コア SQL3 V 2.1 a 単一の表およびその表に関連した索引のリストに関する統計を返します。
SQLTablePrivileges() レベル 2 SQL3 V 2.1 表のリストおよび各表に関連した特権のリストを返します。
SQLTables() コア SQL3 V 2.1 a 特定のデータ・ソースに保管された表名のリストを返します。
ステートメントの終了
SQLFreeHandle() コア 95 V 1.1 ハンドル資源を解放します。
SQLFreeStmt() コア 95 V 1.1 ステートメント処理を終了し、関連したカーソルをクローズし、保留中の結果を廃棄し、任意選択で、ステートメント・ハンドルに関連したすべての資源を解放します。
SQLCancel() コア 95 V 1.1 SQL ステートメントを取り消します。
SQLTransact() Depr なし V 1.1 トランザクションをコミットまたはロールバックします。
SQLCloseCursor() コア 95 V 5 トランザクションをコミットまたはロールバックします。
接続の終了
SQLDisconnect() コア 95 V 1.1 接続をクローズします。
SQLEndTran() コア 95 V 5 接続のトランザクションを終了します。
SQLFreeConnect() Depr 95 V 1.1 接続ハンドルを解放します。
SQLFreeEnv() Depr 95 V 1.1 環境ハンドルを解放します。
注:

a
この関数の実行時サポートは、DB2 クライアント・アプリケーション・イネーブラー (DOS 版) バージョン 1.2 製品でも利用可能でした。

b
SQLBindParam() に代わって SQLBindParameter() が使用されています。

ODBC 関数:

  • SQLSetScrollOptions は、すでに SQL_CURSOR_TYPE、SQL_CONCURRENCY、SQL_KEYSET_SIZE、および SQL_ROWSET_SIZE ステートメント・オプションに置き換えられているため、実行時でのみサポートされます。
  • SQLDrivers() は、ODBC ドライバー・マネージャーによって実装されています。


[ ページのトップ | 前ページ | 次ページ | 目次 | 索引 ]