Win32 API 日本語リファレンス
ホームSystem.GroupPolicy › GetGPOListA

GetGPOListA

関数
適用されるGPOの一覧を取得する(ANSI版)。
DLLUSERENV.dll文字セットANSI (-A)呼出規約winapiSetLastErrorあり対応OSWindows Vista 以降

シグネチャ

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

BOOL GetGPOListA(
    HANDLE hToken,   // optional
    LPCSTR lpName,   // optional
    LPCSTR lpHostName,   // optional
    LPCSTR lpComputerName,   // optional
    DWORD dwFlags,
    GROUP_POLICY_OBJECTA** pGPOList
);

パラメーター

名前方向
hTokenHANDLEinoptional
lpNameLPCSTRinoptional
lpHostNameLPCSTRinoptional
lpComputerNameLPCSTRinoptional
dwFlagsDWORDin
pGPOListGROUP_POLICY_OBJECTA**out

戻り値の型: BOOL

各言語での呼び出し定義

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

BOOL GetGPOListA(
    HANDLE hToken,   // optional
    LPCSTR lpName,   // optional
    LPCSTR lpHostName,   // optional
    LPCSTR lpComputerName,   // optional
    DWORD dwFlags,
    GROUP_POLICY_OBJECTA** pGPOList
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("USERENV.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern bool GetGPOListA(
    IntPtr hToken,   // HANDLE optional
    [MarshalAs(UnmanagedType.LPStr)] string lpName,   // LPCSTR optional
    [MarshalAs(UnmanagedType.LPStr)] string lpHostName,   // LPCSTR optional
    [MarshalAs(UnmanagedType.LPStr)] string lpComputerName,   // LPCSTR optional
    uint dwFlags,   // DWORD
    IntPtr pGPOList   // GROUP_POLICY_OBJECTA** out
);
<DllImport("USERENV.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GetGPOListA(
    hToken As IntPtr,   ' HANDLE optional
    <MarshalAs(UnmanagedType.LPStr)> lpName As String,   ' LPCSTR optional
    <MarshalAs(UnmanagedType.LPStr)> lpHostName As String,   ' LPCSTR optional
    <MarshalAs(UnmanagedType.LPStr)> lpComputerName As String,   ' LPCSTR optional
    dwFlags As UInteger,   ' DWORD
    pGPOList As IntPtr   ' GROUP_POLICY_OBJECTA** out
) As Boolean
End Function
' hToken : HANDLE optional
' lpName : LPCSTR optional
' lpHostName : LPCSTR optional
' lpComputerName : LPCSTR optional
' dwFlags : DWORD
' pGPOList : GROUP_POLICY_OBJECTA** out
Declare PtrSafe Function GetGPOListA Lib "userenv" ( _
    ByVal hToken As LongPtr, _
    ByVal lpName As String, _
    ByVal lpHostName As String, _
    ByVal lpComputerName As String, _
    ByVal dwFlags As Long, _
    ByVal pGPOList As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

GetGPOListA = ctypes.windll.userenv.GetGPOListA
GetGPOListA.restype = wintypes.BOOL
GetGPOListA.argtypes = [
    wintypes.HANDLE,  # hToken : HANDLE optional
    wintypes.LPCSTR,  # lpName : LPCSTR optional
    wintypes.LPCSTR,  # lpHostName : LPCSTR optional
    wintypes.LPCSTR,  # lpComputerName : LPCSTR optional
    wintypes.DWORD,  # dwFlags : DWORD
    ctypes.c_void_p,  # pGPOList : GROUP_POLICY_OBJECTA** out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('USERENV.dll')
GetGPOListA = Fiddle::Function.new(
  lib['GetGPOListA'],
  [
    Fiddle::TYPE_VOIDP,  # hToken : HANDLE optional
    Fiddle::TYPE_VOIDP,  # lpName : LPCSTR optional
    Fiddle::TYPE_VOIDP,  # lpHostName : LPCSTR optional
    Fiddle::TYPE_VOIDP,  # lpComputerName : LPCSTR optional
    -Fiddle::TYPE_INT,  # dwFlags : DWORD
    Fiddle::TYPE_VOIDP,  # pGPOList : GROUP_POLICY_OBJECTA** out
  ],
  Fiddle::TYPE_INT)
#[link(name = "userenv")]
extern "system" {
    fn GetGPOListA(
        hToken: *mut core::ffi::c_void,  // HANDLE optional
        lpName: *const u8,  // LPCSTR optional
        lpHostName: *const u8,  // LPCSTR optional
        lpComputerName: *const u8,  // LPCSTR optional
        dwFlags: u32,  // DWORD
        pGPOList: *mut *mut GROUP_POLICY_OBJECTA  // GROUP_POLICY_OBJECTA** out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("USERENV.dll", CharSet = CharSet.Ansi, SetLastError = true)]
public static extern bool GetGPOListA(IntPtr hToken, [MarshalAs(UnmanagedType.LPStr)] string lpName, [MarshalAs(UnmanagedType.LPStr)] string lpHostName, [MarshalAs(UnmanagedType.LPStr)] string lpComputerName, uint dwFlags, IntPtr pGPOList);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USERENV_GetGPOListA' -Namespace Win32 -PassThru
# $api::GetGPOListA(hToken, lpName, lpHostName, lpComputerName, dwFlags, pGPOList)
#uselib "USERENV.dll"
#func global GetGPOListA "GetGPOListA" sptr, sptr, sptr, sptr, sptr, sptr
; GetGPOListA hToken, lpName, lpHostName, lpComputerName, dwFlags, varptr(pGPOList)   ; 戻り値は stat
; hToken : HANDLE optional -> "sptr"
; lpName : LPCSTR optional -> "sptr"
; lpHostName : LPCSTR optional -> "sptr"
; lpComputerName : LPCSTR optional -> "sptr"
; dwFlags : DWORD -> "sptr"
; pGPOList : GROUP_POLICY_OBJECTA** out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "USERENV.dll"
#cfunc global GetGPOListA "GetGPOListA" sptr, str, str, str, int, var
; res = GetGPOListA(hToken, lpName, lpHostName, lpComputerName, dwFlags, pGPOList)
; hToken : HANDLE optional -> "sptr"
; lpName : LPCSTR optional -> "str"
; lpHostName : LPCSTR optional -> "str"
; lpComputerName : LPCSTR optional -> "str"
; dwFlags : DWORD -> "int"
; pGPOList : GROUP_POLICY_OBJECTA** out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; BOOL GetGPOListA(HANDLE hToken, LPCSTR lpName, LPCSTR lpHostName, LPCSTR lpComputerName, DWORD dwFlags, GROUP_POLICY_OBJECTA** pGPOList)
#uselib "USERENV.dll"
#cfunc global GetGPOListA "GetGPOListA" intptr, str, str, str, int, var
; res = GetGPOListA(hToken, lpName, lpHostName, lpComputerName, dwFlags, pGPOList)
; hToken : HANDLE optional -> "intptr"
; lpName : LPCSTR optional -> "str"
; lpHostName : LPCSTR optional -> "str"
; lpComputerName : LPCSTR optional -> "str"
; dwFlags : DWORD -> "int"
; pGPOList : GROUP_POLICY_OBJECTA** out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	userenv = windows.NewLazySystemDLL("USERENV.dll")
	procGetGPOListA = userenv.NewProc("GetGPOListA")
)

// hToken (HANDLE optional), lpName (LPCSTR optional), lpHostName (LPCSTR optional), lpComputerName (LPCSTR optional), dwFlags (DWORD), pGPOList (GROUP_POLICY_OBJECTA** out)
r1, _, err := procGetGPOListA.Call(
	uintptr(hToken),
	uintptr(unsafe.Pointer(windows.BytePtrFromString(lpName))),
	uintptr(unsafe.Pointer(windows.BytePtrFromString(lpHostName))),
	uintptr(unsafe.Pointer(windows.BytePtrFromString(lpComputerName))),
	uintptr(dwFlags),
	uintptr(pGPOList),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function GetGPOListA(
  hToken: THandle;   // HANDLE optional
  lpName: PAnsiChar;   // LPCSTR optional
  lpHostName: PAnsiChar;   // LPCSTR optional
  lpComputerName: PAnsiChar;   // LPCSTR optional
  dwFlags: DWORD;   // DWORD
  pGPOList: Pointer   // GROUP_POLICY_OBJECTA** out
): BOOL; stdcall;
  external 'USERENV.dll' name 'GetGPOListA';
result := DllCall("USERENV\GetGPOListA"
    , "Ptr", hToken   ; HANDLE optional
    , "AStr", lpName   ; LPCSTR optional
    , "AStr", lpHostName   ; LPCSTR optional
    , "AStr", lpComputerName   ; LPCSTR optional
    , "UInt", dwFlags   ; DWORD
    , "Ptr", pGPOList   ; GROUP_POLICY_OBJECTA** out
    , "Int")   ; return: BOOL
●GetGPOListA(hToken, lpName, lpHostName, lpComputerName, dwFlags, pGPOList) = DLL("USERENV.dll", "bool GetGPOListA(void*, char*, char*, char*, dword, void*)")
# 呼び出し: GetGPOListA(hToken, lpName, lpHostName, lpComputerName, dwFlags, pGPOList)
# hToken : HANDLE optional -> "void*"
# lpName : LPCSTR optional -> "char*"
# lpHostName : LPCSTR optional -> "char*"
# lpComputerName : LPCSTR optional -> "char*"
# dwFlags : DWORD -> "dword"
# pGPOList : GROUP_POLICY_OBJECTA** out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。