GetPrimaryKeysメソッド

機能

プライマリキー一覧を取得するために,classListPrimaryKeysオブジェクトへのポインタを取得します。

形式

classListPrimaryKeys *GetPrimaryKeys(LPCTSTR lpctOwner,
                                 LPCTSTR lpctTableName,
                                 LPCTSTR lpctCondition = NULL,
                                 LPCTSTR lpctEscChar = NULL)
                                                 throw DBSQLCA

引数

lpctOwner

テーブルの所有者名を指定します。

lpctTableName

テーブル名を指定します。

lpctCondition

一覧に含むプライマリキーのフィールド名をワイルドカードで指定します。この指定には,SQLのLIKE演算子に指定する文字列の形式を使用してください。SQL Anywhere,Adaptive Server Anywhere,SQL Serverの場合,この引数は指定できません。

lpctEscChar

ワイルドカード文字列中に含むエスケープ文字を1文字指定します。2文字以上を指定した場合は先頭の文字を使用します。SQL Anywhere,Adaptive Server Anywhere,SQL Serverの場合,この引数は指定できません。

戻り値

データ型:classListPrimaryKeys*

classListPrimaryKeysオブジェクトへのポインタ。

機能詳細

指定したテーブルのプライマリキーを構成するフィールドの一覧情報を持つclassListPrimaryKeysオブジェクトへのポインタを取得します。

プライマリキーの優先順位をキーにして,昇順にソートして取得します。ただし,SQL Anywhere,Adaptive Server Anywhereの場合は,順序はDBMSに依存するため,ソートされません。

使用しているDBMSがHiRDB,又はXDM/RDの場合,プライマリキーの一覧は取得できません。

このメソッドは,非同期実行可能なメソッドです。

発生する例外

DBSQLCA(RetCode)

DB_ERROR_NOT_ENOUGH_MEMORY
メモリ容量が不足しています。
DB_ERROR_CANNOT_BE_NULL
所有者名,又はテーブル名にNULLを指定しています。
DB_ERROR_DRIVER_ERROR
DBMSでエラーが発生しました。
DB_ERROR_DAB_ACCESS_ERROR
DABrokerでエラーが発生しました。
DBSQLCAクラスで詳細コードを確認してください。
DB_ERROR_DAB_SYSTEMCALL_ERROR
システムコールでエラーが発生しました。
DBSQLCAクラスで詳細コードを確認してください。
DB_ERROR_DAB_ILLEGAL_VALUE
指定した引数が不正です。
DBSQLCAクラスで詳細コードを確認してください。
DB_ERROR_TIMEOUT
タイムアウトが発生したため制御を戻します。