- 24.1.5 Connector/ODBC 参考資料
- 24.1.5.1 Connector/ODBC API 参考資料
- 24.1.5.2 Connector/ODBC データタイプ
- 24.1.5.3 Connector/ODBC エラーコード :
このセクションでは、関数によって分類された ODBC ルーチンの要約を記載します。
完全な ODBC API 参考資料は、http://msdn.microsoft.com/library/en-us/odbc/htm/odbcabout_this_manual.asp の ODBC Programer's Reference をご覧ください。
アプリケーションは SQLGetInfo
関数を呼び出し、Connector/ODBC
の適合性情報を得ることができます。ドライバの特定の機能へのサポートに関する情報を得るには、アプリケーションで
SQLGetFunctions
を呼び出すことができます。
注意
後方互換性に関しては、Connector/ODBC 3.51 はすべての推奨されない関数をサポートしています。
以下のテーブルは、作業別に分類された Connector/ODBC API 呼び出しをリストアップしています。
データソースへの接続 :
| Connector/ODBC | ||||
| 関数名 | 2.50 | 3.51 | 標準 | 目的 |
SQLAllocHandle |
No | Yes | ISO 92 | 環境、接続、ステートメント、または記述子ハンドルの獲得 |
SQLConnect |
Yes | Yes | ISO 92 | データソース名、ユーザ ID とパスワードで特定のドライバに接続 |
SQLDriverConnect |
Yes | Yes | ODBC | 接続ストリングもしくは、Driver Manager とドライバがユーザのために接続ダイアログ ボックスを表示する要求によって特定のドライバに接続 |
SQLAllocEnv |
Yes | Yes | Deprecated | ドライバから割り振られた環境ハンドルの獲得 |
SQLAllocConnect |
Yes | Yes | Deprecated | 接続ハンドルの獲得 |
ドライバとデータソースの情報獲得 :
| Connector/ODBC | ||||
| 関数名 | 2.50 | 3.51 | 標準 | 目的 |
SQLDataSources |
No | No | ISO 92 | 利用可能なデータソースのリストを戻す、Driver Manager で扱う |
SQLDrivers |
No | No | ODBC | インストールされたドライバとその属性情報のリストを戻す、Driver Manager で扱う |
SQLGetInfo |
Yes | Yes | ISO 92 | 特定のドライバとデータソースの情報を戻す |
SQLGetFunctions |
Yes | Yes | ISO 92 | サポートされているドライバ関数を戻す |
SQLGetTypeInfo |
Yes | Yes | ISO 92 | サポートされているドライバ関数を戻す |
ドライバ属性の設定と検索
| Connector/ODBC | ||||
| 関数名 | 2.50 | 3.51 | 標準 | 目的 |
SQLSetConnectAttr |
No | Yes | ISO 92 | 接続属性の設定 |
SQLGetConnectAttr |
No | Yes | ISO 92 | 接続属性の値を戻す |
SQLSetConnectOption |
Yes | Yes | Deprecated | 接続オプションの設定 |
SQLGetConnectOption |
Yes | Yes | Deprecated | 接続オプションの値を戻す |
SQLSetEnvAttr |
No | Yes | ISO 92 | 環境属性を設定 |
SQLGetEnvAttr |
No | Yes | ISO 92 | 環境属性の値を戻す |
SQLSetStmtAttr |
No | Yes | ISO 92 | ステートメント属性を設定 |
SQLGetStmtAttr |
No | Yes | ISO 92 | ステートメント属性の値を戻す |
SQLSetStmtOption |
Yes | Yes | Deprecated | ステートメント オプションの設定 |
SQLGetStmtOption |
Yes | Yes | Deprecated | ステートメント オプションの値を戻す |
SQL リクエストの準備 :
| Connector/ODBC | ||||
| 関数名 | 2.50 | 3.51 | 標準 | 目的 |
SQLAllocStmt |
Yes | Yes | Deprecated | ステートメント ハンドルの割り振り |
SQLPrepare |
Yes | Yes | ISO 92 | 後の実行のために SQL 文を準備 |
SQLBindParameter |
Yes | Yes | ODBC | SQL 文中のパラメータのストレージを割り当て |
SQLGetCursorName |
Yes | Yes | ISO 92 | ステートメント ハンドルに関連するカーソル名を戻す |
SQLSetCursorName |
Yes | Yes | ISO 92 | カーソル名の指定 |
SQLSetScrollOptions |
Yes | Yes | ODBC | カーソルの挙動をコントロールするオプションの設定 |
リクエストのサブミット :
| Connector/ODBC | ||||
| 関数名 | 2.50 | 3.51 | 標準 | 目的 |
SQLExecute |
Yes | Yes | ISO 92 | 準備されたステートメントの実行 |
SQLExecDirect |
Yes | Yes | ISO 92 | ステートメントの実行 |
SQLNativeSql |
Yes | Yes | ODBC | ドライバに変換された SQL 文のテキストを戻す |
SQLDescribeParam |
Yes | Yes | ODBC | ステートメント中の特定のパラメータの概要を戻す |
SQLNumParams |
Yes | Yes | ISO 92 | ステートメント中のパラメータの数を戻す |
SQLParamData |
Yes | Yes | ISO 92 | 実行時にパラメータ データを供給するために
SQLPutData と併せて使用 (
長いデータ値に最適 ) |
SQLPutData |
Yes | Yes | ISO 92 | パラメータのデータ値の一部または全てを送信 ( 長いデータ値に最適 ) |
結果と結果の情報の検索 :
| Connector/ODBC | ||||
| 関数名 | 2.50 | 3.51 | 標準 | 目的 |
SQLRowCount |
Yes | Yes | ISO 92 | インサートに影響を受ける行の数、アップデート、または削除要求を戻す |
SQLNumResultCols |
Yes | Yes | ISO 92 | 結果セット内のカラムの数を戻す |
SQLDescribeCol |
Yes | Yes | ISO 92 | 結果セット内のカラムを説明 |
SQLColAttribute |
No | Yes | ISO 92 | 結果セット内のカラムの属性を説明 |
SQLColAttributes |
Yes | Yes | Deprecated | 結果セット内のカラムの属性を説明 |
SQLFetch |
Yes | Yes | ISO 92 | 複数の結果行を戻す |
SQLFetchScroll |
No | Yes | ISO 92 | スクロール可能な結果行を戻す |
SQLExtendedFetch |
Yes | Yes | Deprecated | スクロール可能な結果行を戻す |
SQLSetPos |
Yes | Yes | ODBC | カーソルをデータの摘出されたブロックに配置し、行セットでアプリケーションがデータをリフレッシュできるようにする、または結果セットのデータをアップデートもしくは削除する |
SQLBulkOperations |
No | Yes | ODBC | アップデート、削除、ブックマークによる摘出を含むバルク インサートおよびバルク ブックマーク操作を実施 |
エラーまたは診断情報の検索 :
| Connector/ODBC | ||||
| 関数名 | 2.50 | 3.51 | 標準 | 目的 |
SQLError |
Yes | Yes | Deprecated | 追加のエラーまたはステータス情報を戻す |
SQLGetDiagField |
Yes | Yes | ISO 92 | 追加の診断情報 ( 診断データ構造のひとつのフィールド ) を戻す |
SQLGetDiagRec |
Yes | Yes | ISO 92 | 追加の診断情報 ( 診断データ構造の複数の ) を戻す |
データソースのシステム テーブル ( カタログ機能 ) アイテム情報の獲得 :
| Connector/ODBC | ||||
| 関数名 | 2.50 | 3.51 | 標準 | 目的 |
SQLColumnPrivileges |
Yes | Yes | ODBC | ひとつまたは複数のテーブルにカラムと関連権限のリストを戻す |
SQLColumns |
Yes | Yes | X/Open | 特定のテーブルにカラム名のリストを戻す |
SQLForeignKeys |
Yes | Yes | ODBC | 外部キーになるカラム名が特定のテーブルに既存していれば、リストを戻す |
SQLPrimaryKeys |
Yes | Yes | ODBC | テーブルの基本キーになるカラム名のリストを戻す |
SQLSpecialColumns |
Yes | Yes | X/Open | 指定のテーブルで行をユニークに特定するカラムの最適なセット、またはトランザクションで行の値のどれかがアップデートされた際、自動的にアップデートされるカラムを戻す |
SQLStatistics |
Yes | Yes | ISO 92 | 単一のテーブルのスタティック、およびテーブルに関連するインデックスのリストを戻す |
SQLTablePrivileges |
Yes | Yes | ODBC | テーブルのリストと、各テーブルに関連する権限を戻す |
SQLTables |
Yes | Yes | X/Open | 特定のデータソースに格納されたテーブル名のリストを戻す |
トランザクションの実行 :
| Connector/ODBC | ||||
| 関数名 | 2.50 | 3.51 | 標準 | 目的 |
SQLTransact |
Yes | Yes | Deprecated | トランザクションのコミットまたはロールバック |
SQLEndTran |
No | Yes | ISO 92 | トランザクションのコミットまたはロールバック |
ステートメントの終了 :
| Connector/ODBC | ||||
| 関数名 | 2.50 | 3.51 | 標準 | 目的 |
SQLFreeStmt |
Yes | Yes | ISO 92 | ステートメントの処理の終了、保留中の結果の破棄、またオプションとしてステートメント ハンドルに関連するすべてのソースの解放 |
SQLCloseCursor |
Yes | Yes | ISO 92 | ステートメント ハンドルで開かれていたカーソルを閉じる |
SQLCancel |
Yes | Yes | ISO 92 | SQL 文のキャンセル |
接続の終了 :
| Connector/ODBC | ||||
| 関数名 | 2.50 | 3.51 | 標準 | 目的 |
SQLDisconnect |
Yes | Yes | ISO 92 | 接続の終了 |
SQLFreeHandle |
No | Yes | ISO 92 | 環境、接続、ステートメント、または記述子ハンドルの解放 |
SQLFreeConnect |
Yes | Yes | Deprecated | 接続ハンドルの解放 |
SQLFreeEnv |
Yes | Yes | Deprecated | 環境ハンドルの解放 |
