ホーム › Security › GetSecurityDescriptorGroup

GetSecurityDescriptorGroup

関数

セキュリティ記述子からプライマリグループSIDを取得する。

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

シグネチャ

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

BOOL GetSecurityDescriptorGroup(
    PSECURITY_DESCRIPTOR pSecurityDescriptor,
    PSID* pGroup,
    BOOL* lpbGroupDefaulted
);

パラメーター

名前	型	方向	説明
pSecurityDescriptor	PSECURITY_DESCRIPTOR	in	プライマリグループ情報を取得する対象の SECURITY_DESCRIPTOR 構造体へのポインターです。
pGroup	PSID*	out	関数が返ったときにプライマリグループを識別する security identifier (SID) へのポインターへのポインターです。セキュリティ記述子にプライマリグループが含まれていない場合、関数は pGroup が指すポインターを NULL に設定し、残りの出力パラメーター lpbGroupDefaulted を無視します。セキュリティ記述子にプライマリグループが含まれている場合、関数は pGroup が指すポインターをセキュリティ記述子のグループ SID のアドレスに設定し、lpbGroupDefaulted が指す変数に有効な値を設定します。
lpbGroupDefaulted	BOOL*	out	関数が返るときに、 SECURITY_DESCRIPTOR_CONTROL 構造体の SE_GROUP_DEFAULTED フラグの値が設定されるフラグへのポインターです。pGroup パラメーターが指す変数に格納された値が NULL の場合、値は設定されません。

戻り値の型: BOOL

公式ドキュメント

セキュリティ記述子からプライマリグループの情報を取得します。

戻り値

関数が成功した場合は、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 GetSecurityDescriptorGroup(
    PSECURITY_DESCRIPTOR pSecurityDescriptor,
    PSID* pGroup,
    BOOL* lpbGroupDefaulted
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("ADVAPI32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool GetSecurityDescriptorGroup(
    IntPtr pSecurityDescriptor,   // PSECURITY_DESCRIPTOR
    IntPtr pGroup,   // PSID* out
    out bool lpbGroupDefaulted   // BOOL* out
);

<DllImport("ADVAPI32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GetSecurityDescriptorGroup(
    pSecurityDescriptor As IntPtr,   ' PSECURITY_DESCRIPTOR
    pGroup As IntPtr,   ' PSID* out
    <Out> ByRef lpbGroupDefaulted As Boolean   ' BOOL* out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' pSecurityDescriptor : PSECURITY_DESCRIPTOR
' pGroup : PSID* out
' lpbGroupDefaulted : BOOL* out
Declare PtrSafe Function GetSecurityDescriptorGroup Lib "advapi32" ( _
    ByVal pSecurityDescriptor As LongPtr, _
    ByVal pGroup As LongPtr, _
    ByRef lpbGroupDefaulted As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

GetSecurityDescriptorGroup = ctypes.windll.advapi32.GetSecurityDescriptorGroup
GetSecurityDescriptorGroup.restype = wintypes.BOOL
GetSecurityDescriptorGroup.argtypes = [
    wintypes.HANDLE,  # pSecurityDescriptor : PSECURITY_DESCRIPTOR
    ctypes.c_void_p,  # pGroup : PSID* out
    ctypes.c_void_p,  # lpbGroupDefaulted : BOOL* out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ADVAPI32.dll')
GetSecurityDescriptorGroup = Fiddle::Function.new(
  lib['GetSecurityDescriptorGroup'],
  [
    Fiddle::TYPE_VOIDP,  # pSecurityDescriptor : PSECURITY_DESCRIPTOR
    Fiddle::TYPE_VOIDP,  # pGroup : PSID* out
    Fiddle::TYPE_VOIDP,  # lpbGroupDefaulted : BOOL* out
  ],
  Fiddle::TYPE_INT)

#[link(name = "advapi32")]
extern "system" {
    fn GetSecurityDescriptorGroup(
        pSecurityDescriptor: *mut core::ffi::c_void,  // PSECURITY_DESCRIPTOR
        pGroup: *mut *mut core::ffi::c_void,  // PSID* out
        lpbGroupDefaulted: *mut i32  // BOOL* 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 GetSecurityDescriptorGroup(IntPtr pSecurityDescriptor, IntPtr pGroup, out bool lpbGroupDefaulted);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ADVAPI32_GetSecurityDescriptorGroup' -Namespace Win32 -PassThru
# $api::GetSecurityDescriptorGroup(pSecurityDescriptor, pGroup, lpbGroupDefaulted)

#uselib "ADVAPI32.dll"
#func global GetSecurityDescriptorGroup "GetSecurityDescriptorGroup" sptr, sptr, sptr
; GetSecurityDescriptorGroup pSecurityDescriptor, pGroup, varptr(lpbGroupDefaulted)   ; 戻り値は stat
; pSecurityDescriptor : PSECURITY_DESCRIPTOR -> "sptr"
; pGroup : PSID* out -> "sptr"
; lpbGroupDefaulted : BOOL* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "ADVAPI32.dll"
#cfunc global GetSecurityDescriptorGroup "GetSecurityDescriptorGroup" sptr, sptr, var
; res = GetSecurityDescriptorGroup(pSecurityDescriptor, pGroup, lpbGroupDefaulted)
; pSecurityDescriptor : PSECURITY_DESCRIPTOR -> "sptr"
; pGroup : PSID* out -> "sptr"
; lpbGroupDefaulted : BOOL* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "ADVAPI32.dll"
#cfunc global GetSecurityDescriptorGroup "GetSecurityDescriptorGroup" sptr, sptr, sptr
; res = GetSecurityDescriptorGroup(pSecurityDescriptor, pGroup, varptr(lpbGroupDefaulted))
; pSecurityDescriptor : PSECURITY_DESCRIPTOR -> "sptr"
; pGroup : PSID* out -> "sptr"
; lpbGroupDefaulted : BOOL* out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。