ホーム › Security › CreateWellKnownSid

CreateWellKnownSid

関数

既知のSID種別から対応するSIDを作成する。

DLLADVAPI32.dll呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

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

BOOL CreateWellKnownSid(
    WELL_KNOWN_SID_TYPE WellKnownSidType,
    PSID DomainSid,   // optional
    PSID pSid,   // optional
    DWORD* cbSid
);

パラメーター

名前	型	方向	説明
WellKnownSidType	WELL_KNOWN_SID_TYPE	in	SID が識別する対象を指定する WELL_KNOWN_SID_TYPE 列挙体のメンバー。
DomainSid	PSID	inoptional	SID の作成時に使用するドメインを識別する SID へのポインター。ローカルコンピューターを使用する場合は NULL を渡します。
pSid	PSID	outoptional	CreateWellKnownSid が新しい SID を格納するメモリへのポインター。
cbSid	DWORD*	inout	pSid で利用可能なバイト数を格納する DWORD へのポインター。CreateWellKnownSid 関数は、実際に使用されたバイト数をこの場所に格納します。

戻り値の型: BOOL

公式ドキュメント

定義済みのエイリアスに対応する SID を作成します。

戻り値

関数が成功した場合、戻り値は 0 以外の値です。

関数が失敗した場合、戻り値は 0 です。拡張エラー情報を取得するには、 GetLastError を呼び出します。

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

各言語での呼び出し定義

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

BOOL CreateWellKnownSid(
    WELL_KNOWN_SID_TYPE WellKnownSidType,
    PSID DomainSid,   // optional
    PSID pSid,   // optional
    DWORD* cbSid
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("ADVAPI32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool CreateWellKnownSid(
    int WellKnownSidType,   // WELL_KNOWN_SID_TYPE
    IntPtr DomainSid,   // PSID optional
    IntPtr pSid,   // PSID optional, out
    ref uint cbSid   // DWORD* in/out
);

<DllImport("ADVAPI32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function CreateWellKnownSid(
    WellKnownSidType As Integer,   ' WELL_KNOWN_SID_TYPE
    DomainSid As IntPtr,   ' PSID optional
    pSid As IntPtr,   ' PSID optional, out
    ByRef cbSid As UInteger   ' DWORD* in/out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' WellKnownSidType : WELL_KNOWN_SID_TYPE
' DomainSid : PSID optional
' pSid : PSID optional, out
' cbSid : DWORD* in/out
Declare PtrSafe Function CreateWellKnownSid Lib "advapi32" ( _
    ByVal WellKnownSidType As Long, _
    ByVal DomainSid As LongPtr, _
    ByVal pSid As LongPtr, _
    ByRef cbSid As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

CreateWellKnownSid = ctypes.windll.advapi32.CreateWellKnownSid
CreateWellKnownSid.restype = wintypes.BOOL
CreateWellKnownSid.argtypes = [
    ctypes.c_int,  # WellKnownSidType : WELL_KNOWN_SID_TYPE
    wintypes.HANDLE,  # DomainSid : PSID optional
    wintypes.HANDLE,  # pSid : PSID optional, out
    ctypes.POINTER(wintypes.DWORD),  # cbSid : DWORD* in/out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ADVAPI32.dll')
CreateWellKnownSid = Fiddle::Function.new(
  lib['CreateWellKnownSid'],
  [
    Fiddle::TYPE_INT,  # WellKnownSidType : WELL_KNOWN_SID_TYPE
    Fiddle::TYPE_VOIDP,  # DomainSid : PSID optional
    Fiddle::TYPE_VOIDP,  # pSid : PSID optional, out
    Fiddle::TYPE_VOIDP,  # cbSid : DWORD* in/out
  ],
  Fiddle::TYPE_INT)

#[link(name = "advapi32")]
extern "system" {
    fn CreateWellKnownSid(
        WellKnownSidType: i32,  // WELL_KNOWN_SID_TYPE
        DomainSid: *mut core::ffi::c_void,  // PSID optional
        pSid: *mut core::ffi::c_void,  // PSID optional, out
        cbSid: *mut u32  // DWORD* in/out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("ADVAPI32.dll", SetLastError = true)]
public static extern bool CreateWellKnownSid(int WellKnownSidType, IntPtr DomainSid, IntPtr pSid, ref uint cbSid);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ADVAPI32_CreateWellKnownSid' -Namespace Win32 -PassThru
# $api::CreateWellKnownSid(WellKnownSidType, DomainSid, pSid, cbSid)

#uselib "ADVAPI32.dll"
#func global CreateWellKnownSid "CreateWellKnownSid" sptr, sptr, sptr, sptr
; CreateWellKnownSid WellKnownSidType, DomainSid, pSid, varptr(cbSid)   ; 戻り値は stat
; WellKnownSidType : WELL_KNOWN_SID_TYPE -> "sptr"
; DomainSid : PSID optional -> "sptr"
; pSid : PSID optional, out -> "sptr"
; cbSid : DWORD* in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "ADVAPI32.dll"
#cfunc global CreateWellKnownSid "CreateWellKnownSid" int, sptr, sptr, var
; res = CreateWellKnownSid(WellKnownSidType, DomainSid, pSid, cbSid)
; WellKnownSidType : WELL_KNOWN_SID_TYPE -> "int"
; DomainSid : PSID optional -> "sptr"
; pSid : PSID optional, out -> "sptr"
; cbSid : DWORD* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "ADVAPI32.dll"
#cfunc global CreateWellKnownSid "CreateWellKnownSid" int, sptr, sptr, sptr
; res = CreateWellKnownSid(WellKnownSidType, DomainSid, pSid, varptr(cbSid))
; WellKnownSidType : WELL_KNOWN_SID_TYPE -> "int"
; DomainSid : PSID optional -> "sptr"
; pSid : PSID optional, out -> "sptr"
; cbSid : DWORD* in/out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。