SQLTablePrivileges 関数

準拠
導入されたバージョン: ODBC 1.0 Standards Compliance: ODBC

まとめ
SQLTablePrivileges は 、テーブルの一覧と、各テーブルに関連付けられている特権を返します。 ドライバーは、指定したステートメントの結果セットとして情報を返します。

構文

  
SQLRETURN SQLTablePrivileges(  
     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の場合、 CatalogName は通常の引数です。これはリテラルとして扱われ、その場合は重要です。 詳細については、「 カタログ関数の引数」を参照してください。

NameLength1
[入力]*CatalogName の文字数。

Schemaname
[入力]スキーマ名の文字列検索パターン。 ドライバーが一部のテーブルのスキーマをサポートしているが、他のテーブルではサポートされていない場合 (ドライバーが異なる DBMS からデータを取得する場合など)、空の文字列 ("") はスキーマを持たないテーブルを示します。

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。

診断

SQLTablePrivileges がSQL_ERRORまたはSQL_SUCCESS_WITH_INFOを返す場合、関連付けられた SQLSTATE 値を取得するには、HandleType が SQL_HANDLE_STMT で、Handle of StatementHandle を使用して SQLGetDiagRec を呼び出します。 次の表に、 SQLTablePrivileges によって一般的に返される SQLSTATE 値の一覧を示し、この関数のコンテキストでそれぞれについて説明します。"(DM)" という表記は、ドライバー マネージャーによって返される SQLSTATEs の説明の前にあります。 特に明記されていない限り、各 SQLSTATE 値に関連付けられた戻りコードはSQL_ERRORされます。

説明

SchemaName 引数と TableName 引数は、検索パターンを受け入れます。 有効な検索パターンの詳細については、「 パターン値の引数」を参照してください。

SQLTablePrivileges は、TABLE_CAT、TABLE_SCHEM、TABLE_NAME、PRIVILEGE、GRANTEE で並べ替えられた標準の結果セットとして結果を返します。

TABLE_CAT、TABLE_SCHEM、およびTABLE_NAMEの各列の実際の長さを確認するために、アプリケーションは、SQL_MAX_CATALOG_NAME_LEN、SQL_MAX_SCHEMA_NAME_LEN、およびSQL_MAX_TABLE_NAME_LENオプションを使用して SQLGetInfo を呼び出すことができます。

ODBC 3.x では、次の列の名前が変更されました。 アプリケーションは列番号でバインドされるため、列名の変更は下位互換性には影響しません。

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

コード例

同様の関数のコード例については、「 SQLColumns」を参照してください。

関連する関数

参照

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