Win32 API 日本語リファレンス
ホームSecurity › IsWellKnownSid

IsWellKnownSid

関数
SIDが指定の既知SID種別と一致するかを判定する。
DLLADVAPI32.dll呼出規約winapi対応OSWindows XP 以降

シグネチャ

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

BOOL IsWellKnownSid(
    PSID pSid,
    WELL_KNOWN_SID_TYPE WellKnownSidType
);

パラメーター

名前方向説明
pSidPSIDinテスト対象の SID へのポインター。
WellKnownSidTypeWELL_KNOWN_SID_TYPEinpSid の SID と比較する WELL_KNOWN_SID_TYPE 列挙体のメンバー。

戻り値の型: BOOL

公式ドキュメント

SID をよく知られた SID と比較し、一致する場合は TRUE を返します。

戻り値

pSid の SID が WellKnownSidType で示されるよく知られた SID と一致する場合は TRUE を返します。

それ以外の場合は FALSE を返します。

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

各言語での呼び出し定義

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

BOOL IsWellKnownSid(
    PSID pSid,
    WELL_KNOWN_SID_TYPE WellKnownSidType
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("ADVAPI32.dll", ExactSpelling = true)]
static extern bool IsWellKnownSid(
    IntPtr pSid,   // PSID
    int WellKnownSidType   // WELL_KNOWN_SID_TYPE
);
<DllImport("ADVAPI32.dll", ExactSpelling:=True)>
Public Shared Function IsWellKnownSid(
    pSid As IntPtr,   ' PSID
    WellKnownSidType As Integer   ' WELL_KNOWN_SID_TYPE
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' pSid : PSID
' WellKnownSidType : WELL_KNOWN_SID_TYPE
Declare PtrSafe Function IsWellKnownSid Lib "advapi32" ( _
    ByVal pSid As LongPtr, _
    ByVal WellKnownSidType As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

IsWellKnownSid = ctypes.windll.advapi32.IsWellKnownSid
IsWellKnownSid.restype = wintypes.BOOL
IsWellKnownSid.argtypes = [
    wintypes.HANDLE,  # pSid : PSID
    ctypes.c_int,  # WellKnownSidType : WELL_KNOWN_SID_TYPE
]
require 'fiddle'
require 'fiddle/import'

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

var (
	advapi32 = windows.NewLazySystemDLL("ADVAPI32.dll")
	procIsWellKnownSid = advapi32.NewProc("IsWellKnownSid")
)

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

extern "advapi32" fn IsWellKnownSid(
    pSid: ?*anyopaque, // PSID
    WellKnownSidType: i32 // WELL_KNOWN_SID_TYPE
) callconv(std.os.windows.WINAPI) i32;
proc IsWellKnownSid(
    pSid: pointer,  # PSID
    WellKnownSidType: int32  # WELL_KNOWN_SID_TYPE
): int32 {.importc: "IsWellKnownSid", stdcall, dynlib: "ADVAPI32.dll".}
pragma(lib, "advapi32");
extern(Windows)
int IsWellKnownSid(
    void* pSid,   // PSID
    int WellKnownSidType   // WELL_KNOWN_SID_TYPE
);
ccall((:IsWellKnownSid, "ADVAPI32.dll"), stdcall, Int32,
      (Ptr{Cvoid}, Int32),
      pSid, WellKnownSidType)
# pSid : PSID -> Ptr{Cvoid}
# WellKnownSidType : WELL_KNOWN_SID_TYPE -> Int32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t IsWellKnownSid(
    void* pSid,
    int32_t WellKnownSidType);
]]
local advapi32 = ffi.load("advapi32")
-- advapi32.IsWellKnownSid(pSid, WellKnownSidType)
-- pSid : PSID
-- WellKnownSidType : WELL_KNOWN_SID_TYPE
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('ADVAPI32.dll');
const IsWellKnownSid = lib.func('__stdcall', 'IsWellKnownSid', 'int32_t', ['void *', 'int32_t']);
// IsWellKnownSid(pSid, WellKnownSidType)
// pSid : PSID -> 'void *'
// WellKnownSidType : WELL_KNOWN_SID_TYPE -> 'int32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("ADVAPI32.dll", {
  IsWellKnownSid: { parameters: ["pointer", "i32"], result: "i32" },
});
// lib.symbols.IsWellKnownSid(pSid, WellKnownSidType)
// pSid : PSID -> "pointer"
// WellKnownSidType : WELL_KNOWN_SID_TYPE -> "i32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t IsWellKnownSid(
    void* pSid,
    int32_t WellKnownSidType);
C, "ADVAPI32.dll");
// $ffi->IsWellKnownSid(pSid, WellKnownSidType);
// pSid : PSID
// WellKnownSidType : WELL_KNOWN_SID_TYPE
// 構造体/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 Advapi32 extends StdCallLibrary {
    Advapi32 INSTANCE = Native.load("advapi32", Advapi32.class);
    boolean IsWellKnownSid(
        Pointer pSid,   // PSID
        int WellKnownSidType   // WELL_KNOWN_SID_TYPE
    );
}
@[Link("advapi32")]
lib LibADVAPI32
  fun IsWellKnownSid = IsWellKnownSid(
    pSid : Void*,   # PSID
    WellKnownSidType : Int32   # WELL_KNOWN_SID_TYPE
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef IsWellKnownSidNative = Int32 Function(Pointer<Void>, Int32);
typedef IsWellKnownSidDart = int Function(Pointer<Void>, int);
final IsWellKnownSid = DynamicLibrary.open('ADVAPI32.dll')
    .lookupFunction<IsWellKnownSidNative, IsWellKnownSidDart>('IsWellKnownSid');
// pSid : PSID -> Pointer<Void>
// WellKnownSidType : WELL_KNOWN_SID_TYPE -> Int32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function IsWellKnownSid(
  pSid: THandle;   // PSID
  WellKnownSidType: Integer   // WELL_KNOWN_SID_TYPE
): BOOL; stdcall;
  external 'ADVAPI32.dll' name 'IsWellKnownSid';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "IsWellKnownSid"
  c_IsWellKnownSid :: Ptr () -> Int32 -> IO CInt
-- pSid : PSID -> Ptr ()
-- WellKnownSidType : WELL_KNOWN_SID_TYPE -> Int32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let iswellknownsid =
  foreign "IsWellKnownSid"
    ((ptr void) @-> int32_t @-> returning int32_t)
(* pSid : PSID -> (ptr void) *)
(* WellKnownSidType : WELL_KNOWN_SID_TYPE -> int32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library advapi32 (t "ADVAPI32.dll"))
(cffi:use-foreign-library advapi32)

(cffi:defcfun ("IsWellKnownSid" is-well-known-sid :convention :stdcall) :int32
  (p-sid :pointer)   ; PSID
  (well-known-sid-type :int32))   ; WELL_KNOWN_SID_TYPE
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $IsWellKnownSid = Win32::API::More->new('ADVAPI32',
    'BOOL IsWellKnownSid(HANDLE pSid, int WellKnownSidType)');
# my $ret = $IsWellKnownSid->Call($pSid, $WellKnownSidType);
# pSid : PSID -> HANDLE
# WellKnownSidType : WELL_KNOWN_SID_TYPE -> int
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目
使用する型