16.10.4 SQLPrimaryKeys，SQLPrimaryKeysW
(1) 機能
テーブルに対する主キーを構成する列名を返します。SQL文の結果セットの形式で出力します。
1回の呼び出しで複数のテーブルから主キーを返すことはできません。
(2) 形式
-
SQLPrimaryKeysの場合
SQLRETURN SQLPrimaryKeys ( SQLHSTMT StatementHandle, /* In */ SQLCHAR * CatalogName, /* In */ SQLSMALLINT NameLength1, /* In */ SQLCHAR * SchemaName, /* In */ SQLSMALLINT NameLength2, /* In */ SQLCHAR * TableName, /* In */ SQLSMALLINT NameLength3 /* In */ )
-
SQLPrimaryKeysWの場合
SQLRETURN SQLPrimaryKeysW ( SQLHSTMT StatementHandle, /* In */ SQLWCHAR * CatalogName, /* In */ SQLSMALLINT NameLength1, /* In */ SQLWCHAR * SchemaName, /* In */ SQLSMALLINT NameLength2, /* In */ SQLWCHAR * TableName, /* In */ SQLSMALLINT NameLength3 /* In */ )
(3) 引数
- StatementHandle：
-
ステートメントハンドルを指定します。
この関数を実行する前にSQLAllocHandleの*OutputHandlePtrで出力された値を指定します。
- CatalogName：
-
指定内容をカタログ名として使用します。
指定内容は無効になりますが指定自体は必要なため，この関数を使用する際は，空の文字列（""）またはNULLを指定します。
- NameLength1：
-
*CatalogNameの長さ※，またはSQL_NTSを指定します。
指定内容は無効になりますが指定自体は必要なため，この関数を使用する際は，0を指定します。
- SchemaName：
-
スキーマ名を指定します。NULLを指定した場合は，すべてのスキーマ名を対象にします。
- NameLength2：
-
*SchemaNameの長さ※，またはSQL_NTSを指定します。
0を指定した場合は，SchemaNameによる絞り込みを行いません。
- TableName：
-
テーブル名を指定します。NULLを指定した場合は，すべてのテーブル名を対象にします。
- NameLength3：
-
*TableNameの長さ※，またはSQL_NTSを指定します。
0を指定した場合は，TableNameにNULLが指定されたときと同じ動作となります。
- 注※
-
長さの単位は，SQLPrimaryKeysの場合はバイト長，SQLPrimaryKeysWの場合は文字数となります。
(4) 戻り値
SQL_SUCCESS，SQL_SUCCESS_WITH_INFO，SQL_ERROR，またはSQL_INVALID_HANDLEが返されます。
SQLPrimaryKeysまたはSQLPrimaryKeysWを実行すると結果セットが作成されます。返却される結果セットの形式を次に示します。
|
列番号 |
型 |
列名 |
列の意味 |
|---|---|---|---|
|
1 |
Varchar |
TABLE_CAT |
常にナル値を返します。 |
|
2 |
Varchar |
TABLE_SCHEM |
スキーマ名 |
|
3 |
Varchar |
TABLE_NAME |
表名 |
|
4 |
Varchar |
COLUMN_NAME |
列名 |
|
5 |
Smallint |
KEY_SEQ |
主キー内で付けられる列順の番号 |
|
6 |
Varchar |
PK_NAME |
主キー名 |
(5) SQLSTATE
この関数では次のSQLSTATEを返します。
|
SQLSTATE |
説明 |
備考 |
返却 |
|---|---|---|---|
|
01000 |
一般警告 |
− |
× |
|
08S01 |
通信リンク失敗 |
× |
|
|
24000 |
無効なカーソル状態 |
カーソルがオープンしている状態のときに実行されました。 |
○ |
|
40001 |
直列化の失敗 |
− |
× |
|
40003 |
ステートメントの完了が不明 |
× |
|
|
HY000 |
一般エラー |
× |
|
|
HY001 |
メモリ割り当てエラー |
○ |
|
|
HY008 |
動作がキャンセルされた |
× |
|
|
HY009 |
NULLポインタの不正使用 |
TableNameがNULLポインタです。 |
○ |
|
HY010 |
関数シーケンスエラー |
− |
○ |
|
HY013 |
メモリ管理エラー |
× |
|
|
HY090 |
無効な文字列長または無効なバッファ長 |
名前の長さを格納する引数のどれかの値が，対応する名前の最大長を超えました。 |
○ |
|
HY117 |
接続がサスペンド中 |
− |
× |
|
HYC00 |
オプション機能は実装されていない |
× |
|
|
HYT00 |
タイムアウト終了 |
× |
|
|
HYT01 |
接続タイムアウト終了 |
× |
|
|
IM001 |
ドライバはこの関数をサポートしていない |
× |
|
|
IM017 |
非同期ポーリングが不正 |
× |
|
|
IM018 |
非同期実行が未完了 |
× |
- （凡例）
-
○：HADB ODBCドライバが返すことがあるSQLSTATEです。
×：HADB ODBCドライバが返さないSQLSTATEです。
−：なし。
(6) 注意事項
この関数を実行したHADBユーザが持っている権限によって，取得できる主キーの情報が変わります。権限と取得できる主キーの情報については，マニュアルHADB システム構築・運用ガイドのHADBユーザが参照できるディクショナリ表とシステム表の範囲を参照してください。