GetGPOListW

関数

適用されるGPOの一覧を取得する(Unicode版)。

DLLUSERENV.dll文字セットUnicode (-W)呼出規約winapiSetLastErrorあり対応OSWindows Vista 以降

シグネチャ

// USERENV.dll  (Unicode / -W)
#include <windows.h>

BOOL GetGPOListW(
    HANDLE hToken,   // optional
    LPCWSTR lpName,   // optional
    LPCWSTR lpHostName,   // optional
    LPCWSTR lpComputerName,   // optional
    DWORD dwFlags,
    GROUP_POLICY_OBJECTW** pGPOList
);

パラメーター

名前	型	方向
hToken	HANDLE	inoptional
lpName	LPCWSTR	inoptional
lpHostName	LPCWSTR	inoptional
lpComputerName	LPCWSTR	inoptional
dwFlags	DWORD	in
pGPOList	GROUP_POLICY_OBJECTW**	out

戻り値の型: BOOL

各言語での呼び出し定義

// USERENV.dll  (Unicode / -W)
#include <windows.h>

BOOL GetGPOListW(
    HANDLE hToken,   // optional
    LPCWSTR lpName,   // optional
    LPCWSTR lpHostName,   // optional
    LPCWSTR lpComputerName,   // optional
    DWORD dwFlags,
    GROUP_POLICY_OBJECTW** pGPOList
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("USERENV.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern bool GetGPOListW(
    IntPtr hToken,   // HANDLE optional
    [MarshalAs(UnmanagedType.LPWStr)] string lpName,   // LPCWSTR optional
    [MarshalAs(UnmanagedType.LPWStr)] string lpHostName,   // LPCWSTR optional
    [MarshalAs(UnmanagedType.LPWStr)] string lpComputerName,   // LPCWSTR optional
    uint dwFlags,   // DWORD
    IntPtr pGPOList   // GROUP_POLICY_OBJECTW** out
);

<DllImport("USERENV.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GetGPOListW(
    hToken As IntPtr,   ' HANDLE optional
    <MarshalAs(UnmanagedType.LPWStr)> lpName As String,   ' LPCWSTR optional
    <MarshalAs(UnmanagedType.LPWStr)> lpHostName As String,   ' LPCWSTR optional
    <MarshalAs(UnmanagedType.LPWStr)> lpComputerName As String,   ' LPCWSTR optional
    dwFlags As UInteger,   ' DWORD
    pGPOList As IntPtr   ' GROUP_POLICY_OBJECTW** out
) As Boolean
End Function

' hToken : HANDLE optional
' lpName : LPCWSTR optional
' lpHostName : LPCWSTR optional
' lpComputerName : LPCWSTR optional
' dwFlags : DWORD
' pGPOList : GROUP_POLICY_OBJECTW** out
Declare PtrSafe Function GetGPOListW Lib "userenv" ( _
    ByVal hToken As LongPtr, _
    ByVal lpName As LongPtr, _
    ByVal lpHostName As LongPtr, _
    ByVal lpComputerName As LongPtr, _
    ByVal dwFlags As Long, _
    ByVal pGPOList As LongPtr) As Long
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

GetGPOListW = ctypes.windll.userenv.GetGPOListW
GetGPOListW.restype = wintypes.BOOL
GetGPOListW.argtypes = [
    wintypes.HANDLE,  # hToken : HANDLE optional
    wintypes.LPCWSTR,  # lpName : LPCWSTR optional
    wintypes.LPCWSTR,  # lpHostName : LPCWSTR optional
    wintypes.LPCWSTR,  # lpComputerName : LPCWSTR optional
    wintypes.DWORD,  # dwFlags : DWORD
    ctypes.c_void_p,  # pGPOList : GROUP_POLICY_OBJECTW** out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('USERENV.dll')
GetGPOListW = Fiddle::Function.new(
  lib['GetGPOListW'],
  [
    Fiddle::TYPE_VOIDP,  # hToken : HANDLE optional
    Fiddle::TYPE_VOIDP,  # lpName : LPCWSTR optional
    Fiddle::TYPE_VOIDP,  # lpHostName : LPCWSTR optional
    Fiddle::TYPE_VOIDP,  # lpComputerName : LPCWSTR optional
    -Fiddle::TYPE_INT,  # dwFlags : DWORD
    Fiddle::TYPE_VOIDP,  # pGPOList : GROUP_POLICY_OBJECTW** out
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "userenv")]
extern "system" {
    fn GetGPOListW(
        hToken: *mut core::ffi::c_void,  // HANDLE optional
        lpName: *const u16,  // LPCWSTR optional
        lpHostName: *const u16,  // LPCWSTR optional
        lpComputerName: *const u16,  // LPCWSTR optional
        dwFlags: u32,  // DWORD
        pGPOList: *mut *mut GROUP_POLICY_OBJECTW  // GROUP_POLICY_OBJECTW** out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("USERENV.dll", CharSet = CharSet.Unicode, SetLastError = true)]
public static extern bool GetGPOListW(IntPtr hToken, [MarshalAs(UnmanagedType.LPWStr)] string lpName, [MarshalAs(UnmanagedType.LPWStr)] string lpHostName, [MarshalAs(UnmanagedType.LPWStr)] string lpComputerName, uint dwFlags, IntPtr pGPOList);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USERENV_GetGPOListW' -Namespace Win32 -PassThru
# $api::GetGPOListW(hToken, lpName, lpHostName, lpComputerName, dwFlags, pGPOList)

#uselib "USERENV.dll"
#func global GetGPOListW "GetGPOListW" wptr, wptr, wptr, wptr, wptr, wptr
; GetGPOListW hToken, lpName, lpHostName, lpComputerName, dwFlags, varptr(pGPOList)   ; 戻り値は stat
; hToken : HANDLE optional -> "wptr"
; lpName : LPCWSTR optional -> "wptr"
; lpHostName : LPCWSTR optional -> "wptr"
; lpComputerName : LPCWSTR optional -> "wptr"
; dwFlags : DWORD -> "wptr"
; pGPOList : GROUP_POLICY_OBJECTW** out -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "USERENV.dll"
#cfunc global GetGPOListW "GetGPOListW" sptr, wstr, wstr, wstr, int, var
; res = GetGPOListW(hToken, lpName, lpHostName, lpComputerName, dwFlags, pGPOList)
; hToken : HANDLE optional -> "sptr"
; lpName : LPCWSTR optional -> "wstr"
; lpHostName : LPCWSTR optional -> "wstr"
; lpComputerName : LPCWSTR optional -> "wstr"
; dwFlags : DWORD -> "int"
; pGPOList : GROUP_POLICY_OBJECTW** out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "USERENV.dll"
#cfunc global GetGPOListW "GetGPOListW" sptr, wstr, wstr, wstr, int, sptr
; res = GetGPOListW(hToken, lpName, lpHostName, lpComputerName, dwFlags, varptr(pGPOList))
; hToken : HANDLE optional -> "sptr"
; lpName : LPCWSTR optional -> "wstr"
; lpHostName : LPCWSTR optional -> "wstr"
; lpComputerName : LPCWSTR optional -> "wstr"
; dwFlags : DWORD -> "int"
; pGPOList : GROUP_POLICY_OBJECTW** out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。

出力引数:

; BOOL GetGPOListW(HANDLE hToken, LPCWSTR lpName, LPCWSTR lpHostName, LPCWSTR lpComputerName, DWORD dwFlags, GROUP_POLICY_OBJECTW** pGPOList)
#uselib "USERENV.dll"
#cfunc global GetGPOListW "GetGPOListW" intptr, wstr, wstr, wstr, int, var
; res = GetGPOListW(hToken, lpName, lpHostName, lpComputerName, dwFlags, pGPOList)
; hToken : HANDLE optional -> "intptr"
; lpName : LPCWSTR optional -> "wstr"
; lpHostName : LPCWSTR optional -> "wstr"
; lpComputerName : LPCWSTR optional -> "wstr"
; dwFlags : DWORD -> "int"
; pGPOList : GROUP_POLICY_OBJECTW** out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。; BOOL GetGPOListW(HANDLE hToken, LPCWSTR lpName, LPCWSTR lpHostName, LPCWSTR lpComputerName, DWORD dwFlags, GROUP_POLICY_OBJECTW** pGPOList)
#uselib "USERENV.dll"
#cfunc global GetGPOListW "GetGPOListW" intptr, wstr, wstr, wstr, int, intptr
; res = GetGPOListW(hToken, lpName, lpHostName, lpComputerName, dwFlags, varptr(pGPOList))
; hToken : HANDLE optional -> "intptr"
; lpName : LPCWSTR optional -> "wstr"
; lpHostName : LPCWSTR optional -> "wstr"
; lpComputerName : LPCWSTR optional -> "wstr"
; dwFlags : DWORD -> "int"
; pGPOList : GROUP_POLICY_OBJECTW** out -> "intptr"
; ※出力/バッファ引数はポインタ方式(token=intptr / 呼び出しは varptr(変数))。

import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	userenv = windows.NewLazySystemDLL("USERENV.dll")
	procGetGPOListW = userenv.NewProc("GetGPOListW")
)

// hToken (HANDLE optional), lpName (LPCWSTR optional), lpHostName (LPCWSTR optional), lpComputerName (LPCWSTR optional), dwFlags (DWORD), pGPOList (GROUP_POLICY_OBJECTW** out)
r1, _, err := procGetGPOListW.Call(
	uintptr(hToken),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(lpName))),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(lpHostName))),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(lpComputerName))),
	uintptr(dwFlags),
	uintptr(pGPOList),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL

function GetGPOListW(
  hToken: THandle;   // HANDLE optional
  lpName: PWideChar;   // LPCWSTR optional
  lpHostName: PWideChar;   // LPCWSTR optional
  lpComputerName: PWideChar;   // LPCWSTR optional
  dwFlags: DWORD;   // DWORD
  pGPOList: Pointer   // GROUP_POLICY_OBJECTW** out
): BOOL; stdcall;
  external 'USERENV.dll' name 'GetGPOListW';

result := DllCall("USERENV\GetGPOListW"
    , "Ptr", hToken   ; HANDLE optional
    , "WStr", lpName   ; LPCWSTR optional
    , "WStr", lpHostName   ; LPCWSTR optional
    , "WStr", lpComputerName   ; LPCWSTR optional
    , "UInt", dwFlags   ; DWORD
    , "Ptr", pGPOList   ; GROUP_POLICY_OBJECTW** out
    , "Int")   ; return: BOOL

●GetGPOListW(hToken, lpName, lpHostName, lpComputerName, dwFlags, pGPOList) = DLL("USERENV.dll", "bool GetGPOListW(void*, char*, char*, char*, dword, void*)")
# 呼び出し: GetGPOListW(hToken, lpName, lpHostName, lpComputerName, dwFlags, pGPOList)
# hToken : HANDLE optional -> "void*"
# lpName : LPCWSTR optional -> "char*"
# lpHostName : LPCWSTR optional -> "char*"
# lpComputerName : LPCWSTR optional -> "char*"
# dwFlags : DWORD -> "dword"
# pGPOList : GROUP_POLICY_OBJECTW** out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。