ホーム › System.Search › SQLTablePrivileges

SQLTablePrivileges

関数

指定テーブルに対するアクセス権限の一覧を返す。

DLLODBC32.dll文字セットANSI (-A)呼出規約winapi

シグネチャ

// ODBC32.dll  (ANSI / -A)
#include <windows.h>

SHORT SQLTablePrivileges(
    void* hstmt,
    BYTE* szCatalogName,   // optional
    SHORT cchCatalogName,
    BYTE* szSchemaName,   // optional
    SHORT cchSchemaName,
    BYTE* szTableName,   // optional
    SHORT cchTableName
);

パラメーター

名前	型	方向	説明
hstmt	void*	inout	結果セットを生成する対象のステートメントハンドル。
szCatalogName	BYTE*	inoptional	カタログ名。ANSI文字列。NULL可。
cchCatalogName	SHORT	in	szCatalogNameの文字数。SQL_NTSでNUL終端を示す。
szSchemaName	BYTE*	inoptional	スキーマ名の検索パターン。ANSI文字列。NULL可。
cchSchemaName	SHORT	in	szSchemaNameの文字数。SQL_NTSでNUL終端を示す。
szTableName	BYTE*	inoptional	テーブル名の検索パターン。ANSI文字列。NULL可。
cchTableName	SHORT	in	szTableNameの文字数。SQL_NTSでNUL終端を示す。

戻り値の型: SHORT

公式ドキュメント

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

戻り値

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

解説(Remarks)

SchemaName および TableName 引数は検索パターンを受け付けます。有効な検索パターンの詳細については、「Pattern Value Arguments」を参照してください。

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 カタログ関数の一般的な使用方法、引数、返されるデータの詳細については、「Catalog Functions」を参照してください。

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

ODBC 2.0 の列	ODBC 3.x の列
TABLE_QUALIFIER	TABLE_CAT
TABLE_OWNER	TABLE_SCHEM

次の表に、結果セットに含まれる列を示します。7 番目の列 (IS_GRANTABLE) より後の列は、ドライバーが追加で定義できます。アプリケーションは、明示的な序数位置を指定するのではなく、結果セットの末尾から数えてドライバー固有の列にアクセスする必要があります。詳細については、「Data Returned by Catalog Functions」を参照してください。

列名	列番号	データ型	コメント
TABLE_CAT (ODBC 1.0)	1	Varchar	カタログ名。データソースに該当しない場合は NULL。ドライバーが一部のテーブルについてはカタログをサポートし、他のテーブルについてはサポートしない場合 (ドライバーが異なる DBMS からデータを取得する場合など)、カタログを持たないテーブルに対しては空の文字列 ("") を返します。
TABLE_SCHEM (ODBC 1.0)	2	Varchar	スキーマ名。データソースに該当しない場合は NULL。ドライバーが一部のテーブルについてはスキーマをサポートし、他のテーブルについてはサポートしない場合 (ドライバーが異なる DBMS からデータを取得する場合など)、スキーマを持たないテーブルに対しては空の文字列 ("") を返します。
TABLE_NAME (ODBC 1.0)	3	Varchar not NULL	テーブル名。
GRANTOR (ODBC 1.0)	4	Varchar	特権を付与したユーザーの名前。データソースに該当しない場合は NULL。 GRANTEE 列の値がオブジェクトの所有者であるすべての行では、GRANTOR 列は "_SYSTEM" になります。
GRANTEE (ODBC 1.0)	5	Varchar not NULL	特権が付与されたユーザーの名前。
PRIVILEGE (ODBC 1.0)	6	Varchar not NULL	テーブルの特権。次のいずれか、またはデータソース固有の特権です。 SELECT: 被付与者は、テーブルの 1 つ以上の列のデータを取得できます。 INSERT: 被付与者は、1 つ以上の列のデータを含む新しい行をテーブルに挿入できます。 UPDATE: 被付与者は、テーブルの 1 つ以上の列のデータを更新できます。 DELETE: 被付与者は、テーブルからデータの行を削除できます。 REFERENCES: 被付与者は、制約 (一意性制約、参照制約、テーブルのチェック制約など) の中でテーブルの 1 つ以上の列を参照できます。特定のテーブル特権によって被付与者に許可される操作の範囲は、データソースに依存します。たとえば、UPDATE 特権は、あるデータソースではテーブル内のすべての列の更新を被付与者に許可し、別のデータソースでは付与者が UPDATE 特権を持つ列のみの更新を許可する場合があります。
IS_GRANTABLE (ODBC 1.0)	7	Varchar	被付与者がその特権を他のユーザーに付与できるかどうかを示します。"YES"、"NO"、または不明な場合やデータソースに該当しない場合は NULL。特権は、付与可能か付与不可能かのいずれかであり、その両方であることはありません。SQLColumnPrivileges が返す結果セットに、IS_GRANTABLE 列以外のすべての列が同じ値である 2 つの行が含まれることはありません。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp)

各言語での呼び出し定義

// ODBC32.dll  (ANSI / -A)
#include <windows.h>

SHORT SQLTablePrivileges(
    void* hstmt,
    BYTE* szCatalogName,   // optional
    SHORT cchCatalogName,
    BYTE* szSchemaName,   // optional
    SHORT cchSchemaName,
    BYTE* szTableName,   // optional
    SHORT cchTableName
);

[DllImport("ODBC32.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern short SQLTablePrivileges(
    IntPtr hstmt,   // void* in/out
    IntPtr szCatalogName,   // BYTE* optional
    short cchCatalogName,   // SHORT
    IntPtr szSchemaName,   // BYTE* optional
    short cchSchemaName,   // SHORT
    IntPtr szTableName,   // BYTE* optional
    short cchTableName   // SHORT
);

<DllImport("ODBC32.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function SQLTablePrivileges(
    hstmt As IntPtr,   ' void* in/out
    szCatalogName As IntPtr,   ' BYTE* optional
    cchCatalogName As Short,   ' SHORT
    szSchemaName As IntPtr,   ' BYTE* optional
    cchSchemaName As Short,   ' SHORT
    szTableName As IntPtr,   ' BYTE* optional
    cchTableName As Short   ' SHORT
) As Short
End Function

' hstmt : void* in/out
' szCatalogName : BYTE* optional
' cchCatalogName : SHORT
' szSchemaName : BYTE* optional
' cchSchemaName : SHORT
' szTableName : BYTE* optional
' cchTableName : SHORT
Declare PtrSafe Function SQLTablePrivileges Lib "odbc32" ( _
    ByVal hstmt As LongPtr, _
    ByVal szCatalogName As LongPtr, _
    ByVal cchCatalogName As Integer, _
    ByVal szSchemaName As LongPtr, _
    ByVal cchSchemaName As Integer, _
    ByVal szTableName As LongPtr, _
    ByVal cchTableName As Integer) As Integer
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

SQLTablePrivileges = ctypes.windll.odbc32.SQLTablePrivileges
SQLTablePrivileges.restype = ctypes.c_short
SQLTablePrivileges.argtypes = [
    ctypes.POINTER(None),  # hstmt : void* in/out
    ctypes.POINTER(ctypes.c_ubyte),  # szCatalogName : BYTE* optional
    ctypes.c_short,  # cchCatalogName : SHORT
    ctypes.POINTER(ctypes.c_ubyte),  # szSchemaName : BYTE* optional
    ctypes.c_short,  # cchSchemaName : SHORT
    ctypes.POINTER(ctypes.c_ubyte),  # szTableName : BYTE* optional
    ctypes.c_short,  # cchTableName : SHORT
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ODBC32.dll')
SQLTablePrivileges = Fiddle::Function.new(
  lib['SQLTablePrivileges'],
  [
    Fiddle::TYPE_VOIDP,  # hstmt : void* in/out
    Fiddle::TYPE_VOIDP,  # szCatalogName : BYTE* optional
    Fiddle::TYPE_SHORT,  # cchCatalogName : SHORT
    Fiddle::TYPE_VOIDP,  # szSchemaName : BYTE* optional
    Fiddle::TYPE_SHORT,  # cchSchemaName : SHORT
    Fiddle::TYPE_VOIDP,  # szTableName : BYTE* optional
    Fiddle::TYPE_SHORT,  # cchTableName : SHORT
  ],
  Fiddle::TYPE_SHORT)

#[link(name = "odbc32")]
extern "system" {
    fn SQLTablePrivileges(
        hstmt: *mut (),  // void* in/out
        szCatalogName: *mut u8,  // BYTE* optional
        cchCatalogName: i16,  // SHORT
        szSchemaName: *mut u8,  // BYTE* optional
        cchSchemaName: i16,  // SHORT
        szTableName: *mut u8,  // BYTE* optional
        cchTableName: i16  // SHORT
    ) -> i16;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("ODBC32.dll", CharSet = CharSet.Ansi)]
public static extern short SQLTablePrivileges(IntPtr hstmt, IntPtr szCatalogName, short cchCatalogName, IntPtr szSchemaName, short cchSchemaName, IntPtr szTableName, short cchTableName);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ODBC32_SQLTablePrivileges' -Namespace Win32 -PassThru
# $api::SQLTablePrivileges(hstmt, szCatalogName, cchCatalogName, szSchemaName, cchSchemaName, szTableName, cchTableName)

#uselib "ODBC32.dll"
#func global SQLTablePrivileges "SQLTablePrivileges" sptr, sptr, sptr, sptr, sptr, sptr, sptr
; SQLTablePrivileges hstmt, varptr(szCatalogName), cchCatalogName, varptr(szSchemaName), cchSchemaName, varptr(szTableName), cchTableName   ; 戻り値は stat
; hstmt : void* in/out -> "sptr"
; szCatalogName : BYTE* optional -> "sptr"
; cchCatalogName : SHORT -> "sptr"
; szSchemaName : BYTE* optional -> "sptr"
; cchSchemaName : SHORT -> "sptr"
; szTableName : BYTE* optional -> "sptr"
; cchTableName : SHORT -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "ODBC32.dll"
#cfunc global SQLTablePrivileges "SQLTablePrivileges" sptr, var, int, var, int, var, int
; res = SQLTablePrivileges(hstmt, szCatalogName, cchCatalogName, szSchemaName, cchSchemaName, szTableName, cchTableName)
; hstmt : void* in/out -> "sptr"
; szCatalogName : BYTE* optional -> "var"
; cchCatalogName : SHORT -> "int"
; szSchemaName : BYTE* optional -> "var"
; cchSchemaName : SHORT -> "int"
; szTableName : BYTE* optional -> "var"
; cchTableName : SHORT -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "ODBC32.dll"
#cfunc global SQLTablePrivileges "SQLTablePrivileges" sptr, sptr, int, sptr, int, sptr, int
; res = SQLTablePrivileges(hstmt, varptr(szCatalogName), cchCatalogName, varptr(szSchemaName), cchSchemaName, varptr(szTableName), cchTableName)
; hstmt : void* in/out -> "sptr"
; szCatalogName : BYTE* optional -> "sptr"
; cchCatalogName : SHORT -> "int"
; szSchemaName : BYTE* optional -> "sptr"
; cchSchemaName : SHORT -> "int"
; szTableName : BYTE* optional -> "sptr"
; cchTableName : SHORT -> "int"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。