Win32 API 日本語リファレンス
ホームUI.Shell › SHTestTokenMembership

SHTestTokenMembership

関数
トークンが指定RIDのグループに属するか判定する。
DLLSHELL32.dll呼出規約winapi対応OSWindows XP 以降

シグネチャ

// SHELL32.dll
#include <windows.h>

BOOL SHTestTokenMembership(
    HANDLE hToken,   // optional
    DWORD ulRID
);

パラメーター

名前方向説明
hTokenHANDLEinoptionalトークンへのハンドル。この値は NULL にできます。
ulRIDDWORDinメンバーシップをテストするローカルグループの RID。

戻り値の型: BOOL

公式ドキュメント

CheckTokenMembership を使用して、指定したトークンが、指定した RID を持つローカルグループのメンバーであるかどうかをテストします。

戻り値

型: BOOL

成功した場合は TRUE、失敗した場合は FALSE を返します。

解説(Remarks)

この関数は CheckTokenMembership をラップしており、ローカルグループのみをチェックします。

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

各言語での呼び出し定義

// SHELL32.dll
#include <windows.h>

BOOL SHTestTokenMembership(
    HANDLE hToken,   // optional
    DWORD ulRID
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("SHELL32.dll", ExactSpelling = true)]
static extern bool SHTestTokenMembership(
    IntPtr hToken,   // HANDLE optional
    uint ulRID   // DWORD
);
<DllImport("SHELL32.dll", ExactSpelling:=True)>
Public Shared Function SHTestTokenMembership(
    hToken As IntPtr,   ' HANDLE optional
    ulRID As UInteger   ' DWORD
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' hToken : HANDLE optional
' ulRID : DWORD
Declare PtrSafe Function SHTestTokenMembership Lib "shell32" ( _
    ByVal hToken As LongPtr, _
    ByVal ulRID As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

SHTestTokenMembership = ctypes.windll.shell32.SHTestTokenMembership
SHTestTokenMembership.restype = wintypes.BOOL
SHTestTokenMembership.argtypes = [
    wintypes.HANDLE,  # hToken : HANDLE optional
    wintypes.DWORD,  # ulRID : DWORD
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SHELL32.dll')
SHTestTokenMembership = Fiddle::Function.new(
  lib['SHTestTokenMembership'],
  [
    Fiddle::TYPE_VOIDP,  # hToken : HANDLE optional
    -Fiddle::TYPE_INT,  # ulRID : DWORD
  ],
  Fiddle::TYPE_INT)
#[link(name = "shell32")]
extern "system" {
    fn SHTestTokenMembership(
        hToken: *mut core::ffi::c_void,  // HANDLE optional
        ulRID: u32  // DWORD
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("SHELL32.dll")]
public static extern bool SHTestTokenMembership(IntPtr hToken, uint ulRID);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHELL32_SHTestTokenMembership' -Namespace Win32 -PassThru
# $api::SHTestTokenMembership(hToken, ulRID)
#uselib "SHELL32.dll"
#func global SHTestTokenMembership "SHTestTokenMembership" sptr, sptr
; SHTestTokenMembership hToken, ulRID   ; 戻り値は stat
; hToken : HANDLE optional -> "sptr"
; ulRID : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "SHELL32.dll"
#cfunc global SHTestTokenMembership "SHTestTokenMembership" sptr, int
; res = SHTestTokenMembership(hToken, ulRID)
; hToken : HANDLE optional -> "sptr"
; ulRID : DWORD -> "int"
; BOOL SHTestTokenMembership(HANDLE hToken, DWORD ulRID)
#uselib "SHELL32.dll"
#cfunc global SHTestTokenMembership "SHTestTokenMembership" intptr, int
; res = SHTestTokenMembership(hToken, ulRID)
; hToken : HANDLE optional -> "intptr"
; ulRID : DWORD -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	shell32 = windows.NewLazySystemDLL("SHELL32.dll")
	procSHTestTokenMembership = shell32.NewProc("SHTestTokenMembership")
)

// hToken (HANDLE optional), ulRID (DWORD)
r1, _, err := procSHTestTokenMembership.Call(
	uintptr(hToken),
	uintptr(ulRID),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function SHTestTokenMembership(
  hToken: THandle;   // HANDLE optional
  ulRID: DWORD   // DWORD
): BOOL; stdcall;
  external 'SHELL32.dll' name 'SHTestTokenMembership';
result := DllCall("SHELL32\SHTestTokenMembership"
    , "Ptr", hToken   ; HANDLE optional
    , "UInt", ulRID   ; DWORD
    , "Int")   ; return: BOOL
●SHTestTokenMembership(hToken, ulRID) = DLL("SHELL32.dll", "bool SHTestTokenMembership(void*, dword)")
# 呼び出し: SHTestTokenMembership(hToken, ulRID)
# hToken : HANDLE optional -> "void*"
# ulRID : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "shell32" fn SHTestTokenMembership(
    hToken: ?*anyopaque, // HANDLE optional
    ulRID: u32 // DWORD
) callconv(std.os.windows.WINAPI) i32;
proc SHTestTokenMembership(
    hToken: pointer,  # HANDLE optional
    ulRID: uint32  # DWORD
): int32 {.importc: "SHTestTokenMembership", stdcall, dynlib: "SHELL32.dll".}
pragma(lib, "shell32");
extern(Windows)
int SHTestTokenMembership(
    void* hToken,   // HANDLE optional
    uint ulRID   // DWORD
);
ccall((:SHTestTokenMembership, "SHELL32.dll"), stdcall, Int32,
      (Ptr{Cvoid}, UInt32),
      hToken, ulRID)
# hToken : HANDLE optional -> Ptr{Cvoid}
# ulRID : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t SHTestTokenMembership(
    void* hToken,
    uint32_t ulRID);
]]
local shell32 = ffi.load("shell32")
-- shell32.SHTestTokenMembership(hToken, ulRID)
-- hToken : HANDLE optional
-- ulRID : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('SHELL32.dll');
const SHTestTokenMembership = lib.func('__stdcall', 'SHTestTokenMembership', 'int32_t', ['void *', 'uint32_t']);
// SHTestTokenMembership(hToken, ulRID)
// hToken : HANDLE optional -> 'void *'
// ulRID : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("SHELL32.dll", {
  SHTestTokenMembership: { parameters: ["pointer", "u32"], result: "i32" },
});
// lib.symbols.SHTestTokenMembership(hToken, ulRID)
// hToken : HANDLE optional -> "pointer"
// ulRID : DWORD -> "u32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t SHTestTokenMembership(
    void* hToken,
    uint32_t ulRID);
C, "SHELL32.dll");
// $ffi->SHTestTokenMembership(hToken, ulRID);
// hToken : HANDLE optional
// ulRID : DWORD
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。
import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;

public interface Shell32 extends StdCallLibrary {
    Shell32 INSTANCE = Native.load("shell32", Shell32.class);
    boolean SHTestTokenMembership(
        Pointer hToken,   // HANDLE optional
        int ulRID   // DWORD
    );
}
@[Link("shell32")]
lib LibSHELL32
  fun SHTestTokenMembership = SHTestTokenMembership(
    hToken : Void*,   # HANDLE optional
    ulRID : UInt32   # DWORD
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef SHTestTokenMembershipNative = Int32 Function(Pointer<Void>, Uint32);
typedef SHTestTokenMembershipDart = int Function(Pointer<Void>, int);
final SHTestTokenMembership = DynamicLibrary.open('SHELL32.dll')
    .lookupFunction<SHTestTokenMembershipNative, SHTestTokenMembershipDart>('SHTestTokenMembership');
// hToken : HANDLE optional -> Pointer<Void>
// ulRID : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SHTestTokenMembership(
  hToken: THandle;   // HANDLE optional
  ulRID: DWORD   // DWORD
): BOOL; stdcall;
  external 'SHELL32.dll' name 'SHTestTokenMembership';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SHTestTokenMembership"
  c_SHTestTokenMembership :: Ptr () -> Word32 -> IO CInt
-- hToken : HANDLE optional -> Ptr ()
-- ulRID : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let shtesttokenmembership =
  foreign "SHTestTokenMembership"
    ((ptr void) @-> uint32_t @-> returning int32_t)
(* hToken : HANDLE optional -> (ptr void) *)
(* ulRID : DWORD -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library shell32 (t "SHELL32.dll"))
(cffi:use-foreign-library shell32)

(cffi:defcfun ("SHTestTokenMembership" shtest-token-membership :convention :stdcall) :int32
  (h-token :pointer)   ; HANDLE optional
  (ul-rid :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SHTestTokenMembership = Win32::API::More->new('SHELL32',
    'BOOL SHTestTokenMembership(HANDLE hToken, DWORD ulRID)');
# my $ret = $SHTestTokenMembership->Call($hToken, $ulRID);
# hToken : HANDLE optional -> HANDLE
# ulRID : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。