SQLPrimaryKeys 関数

適合 性
導入版:ODBC 1.0 規格準拠:ODBC

Summary
SQLPrimaryKeys はテーブルのプライマリキーを構成する列名を返します。 ドライバーは、結果セットとして情報を返します。 この関数は、単一の呼び出しで複数のテーブルからプライマリキーを返すことをサポートしていません。

構文

  
SQLRETURN SQLPrimaryKeys(  
     SQLHSTMT       StatementHandle,  
     SQLCHAR *      CatalogName,  
     SQLSMALLINT    NameLength1,  
     SQLCHAR *      SchemaName,  
     SQLSMALLINT    NameLength2,  
     SQLCHAR *      TableName,  
     SQLSMALLINT    NameLength3);  

引数

StatementHandle
[入力]ステートメント ハンドル。

CatalogName
[入力]カタログ名。 ドライバが一部のテーブルにはカタログをサポートしているが、他のテーブルではサポートしない場合(例えば異なるDBMSからデータを取得する場合など)、空文字列(「」)はカタログを持たないテーブルを示します。 CatalogNameは 文字列検索パターンを含めません。

SQL_ATTR_METADATA_ID文属性がSQL_TRUEに設定されている場合、 CatalogName は識別子として扱われ、その大文字は重要ではありません。 もしSQL_FALSEであれば、 カタログ名 は通常の引数となります。文字通りに扱われており、そのケースは重要です。 詳細については、「カタログ関数の引数」を参照してください。

NameLength1
[入力]*カタログ名の文字数。

スキーマ名
[入力]スキーマ名。 ドライバが一部のテーブルにはスキーマをサポートし、他のテーブルにはサポートしない場合(例えば異なるDBMSからデータを取得する場合など)、空の文字列(「」)はスキーマを持たないテーブルを示します。 SchemaNameは 文字列検索パターンを含めません。

SQL_ATTR_METADATA_ID文属性がSQL_TRUEに設定されている場合、 SchemaName は識別子として扱われ、その大文字は重要ではありません。 もしSQL_FALSEなら、 SchemaName は通常の引数です。文字通りに扱われており、そのケース自体は重要ではありません。

NameLength2
[入力]*SchemaNameの文字数。

テーブル名
[入力]テーブル名。 この引数はヌルポインタにはなり得ません。 TableNameは 文字列検索パターンを含めません。

SQL_ATTR_METADATA_ID文属性がSQL_TRUEに設定されている場合、 TableName は識別子として扱われ、その大文字は重要ではありません。 SQL_FALSEの場合、 TableName は通常の引数です。文字通りに扱われており、そのケース自体は重要ではありません。

NameLength3
[入力]*TableNameの文字数。

返品

SQL_SUCCESS、SQL_SUCCESS_WITH_INFO、SQL_STILL_EXECUTING、SQL_ERROR、またはSQL_INVALID_HANDLE。

Diagnostics

SQLPrimaryKeysがSQL_ERRORまたはSQL_SUCCESS_WITH_INFOを返す場合、SQLGetDiagRecを呼び出し、HandleTypeをSQL_HANDLE_STMT、HandleをStatementHandleで呼び出すことで関連するSQLSTATE値を取得できます。 以下の表は 、SQLPrimaryKeys によって一般的に返されるSQLSTATE値の一覧と、この関数の文脈でのそれぞれの値を説明しています。「(DM)」という表記は、ドライバーマネージャーが返すSQLstateの記述の前に記載されます。 特に明記されていない限り、各 SQLSTATE 値に関連付けられている戻りコードはSQL_ERROR。

Comments

SQLPrimaryKeys は、TABLE_CAT、TABLE_SCHEM、TABLE_NAME、KEY_SEQ順に並べた標準結果セットとして結果を返します。 この情報の使用方法については、「 カタログ データの使用」を参照してください。

以下の列はODBC 3に改名されています。x。 カラム名の変更は後方互換性には影響しません。なぜならアプリケーションはカラム番号でバインドするからです。

TABLE_CAT、TABLE_SCHEM、TABLE_NAME、COLUMN_NAMEの各カラムの実際の長さを把握するには、SQL_MAX_CATALOG_NAME_LEN、SQL_MAX_SCHEMA_NAME_LEN、SQL_MAX_TABLE_NAME_LEN、SQL_MAX_COLUMN_NAME_LENのオプションで SQLGetInfo に連絡してください。

次の表に、結果セットの列を示します。 6列(PK_NAME)以降の追加列はドライバーによって定義可能です。 アプリケーションは、明示的な順序位置を指定するのではなく、結果セットの末尾からカウントダウンすることでドライバー固有の列にアクセスするべきです。 詳細については、「 カタログ関数によって返されるデータ」を参照してください。

コード例

SQLForeignKeysを参照してください。

関連関数

関連するコンテンツ

• ODBC API リファレンス
• ODBC ヘッダー ファイル