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

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
);

パラメーター

名前方向説明
hTokenHANDLEinoptional対象ユーザーのアクセストークンのハンドル。NULL可で現在のユーザーを使う。
lpNameLPCWSTRinoptionalユーザーまたはコンピューターのLDAP識別名(Unicode)。NULL可。
lpHostNameLPCWSTRinoptionalドメインのDNS名(Unicode)。NULL可。
lpComputerNameLPCWSTRinoptional対象コンピューター名(Unicode)。NULL可でローカルを使う。
dwFlagsDWORDinGPO収集の対象や挙動を示すフラグ。マシン/ユーザーやループバック等を指定する。
pGPOListGROUP_POLICY_OBJECTW**out適用GPOの連結リスト(GROUP_POLICY_OBJECTW)の先頭を受け取る出力ポインタ。

戻り値の型: 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 <MarshalAs(UnmanagedType.Bool)> 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 方式にも切替可。
出力引数:
; 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 方式にも切替可。
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 版の利用を推奨。
const std = @import("std");

extern "userenv" fn GetGPOListW(
    hToken: ?*anyopaque, // HANDLE optional
    lpName: [*c]const u16, // LPCWSTR optional
    lpHostName: [*c]const u16, // LPCWSTR optional
    lpComputerName: [*c]const u16, // LPCWSTR optional
    dwFlags: u32, // DWORD
    pGPOList: [*c][*c]GROUP_POLICY_OBJECTW // GROUP_POLICY_OBJECTW** out
) callconv(std.os.windows.WINAPI) i32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc GetGPOListW(
    hToken: pointer,  # HANDLE optional
    lpName: WideCString,  # LPCWSTR optional
    lpHostName: WideCString,  # LPCWSTR optional
    lpComputerName: WideCString,  # LPCWSTR optional
    dwFlags: uint32,  # DWORD
    pGPOList: ptr GROUP_POLICY_OBJECTW  # GROUP_POLICY_OBJECTW** out
): int32 {.importc: "GetGPOListW", stdcall, dynlib: "USERENV.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "userenv");
extern(Windows)
int GetGPOListW(
    void* hToken,   // HANDLE optional
    const(wchar)* lpName,   // LPCWSTR optional
    const(wchar)* lpHostName,   // LPCWSTR optional
    const(wchar)* lpComputerName,   // LPCWSTR optional
    uint dwFlags,   // DWORD
    GROUP_POLICY_OBJECTW** pGPOList   // GROUP_POLICY_OBJECTW** out
);
ccall((:GetGPOListW, "USERENV.dll"), stdcall, Int32,
      (Ptr{Cvoid}, Cwstring, Cwstring, Cwstring, UInt32, Ptr{GROUP_POLICY_OBJECTW}),
      hToken, lpName, lpHostName, lpComputerName, dwFlags, pGPOList)
# hToken : HANDLE optional -> Ptr{Cvoid}
# lpName : LPCWSTR optional -> Cwstring
# lpHostName : LPCWSTR optional -> Cwstring
# lpComputerName : LPCWSTR optional -> Cwstring
# dwFlags : DWORD -> UInt32
# pGPOList : GROUP_POLICY_OBJECTW** out -> Ptr{GROUP_POLICY_OBJECTW}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
int32_t GetGPOListW(
    void* hToken,
    const uint16_t* lpName,
    const uint16_t* lpHostName,
    const uint16_t* lpComputerName,
    uint32_t dwFlags,
    void* pGPOList);
]]
local userenv = ffi.load("userenv")
-- userenv.GetGPOListW(hToken, lpName, lpHostName, lpComputerName, dwFlags, pGPOList)
-- hToken : HANDLE optional
-- lpName : LPCWSTR optional
-- lpHostName : LPCWSTR optional
-- lpComputerName : LPCWSTR optional
-- dwFlags : DWORD
-- pGPOList : GROUP_POLICY_OBJECTW** out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- Unicode(-W): uint16_t* には UTF-16LE のバッファ(ffi.new("uint16_t[?]", ...))を渡す。
const koffi = require('koffi');
const lib = koffi.load('USERENV.dll');
const GetGPOListW = lib.func('__stdcall', 'GetGPOListW', 'int32_t', ['void *', 'str16', 'str16', 'str16', 'uint32_t', 'void *']);
// GetGPOListW(hToken, lpName, lpHostName, lpComputerName, dwFlags, pGPOList)
// hToken : HANDLE optional -> 'void *'
// lpName : LPCWSTR optional -> 'str16'
// lpHostName : LPCWSTR optional -> 'str16'
// lpComputerName : LPCWSTR optional -> 'str16'
// dwFlags : DWORD -> 'uint32_t'
// pGPOList : GROUP_POLICY_OBJECTW** out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("USERENV.dll", {
  GetGPOListW: { parameters: ["pointer", "buffer", "buffer", "buffer", "u32", "pointer"], result: "i32" },
});
// lib.symbols.GetGPOListW(hToken, lpName, lpHostName, lpComputerName, dwFlags, pGPOList)
// hToken : HANDLE optional -> "pointer"
// lpName : LPCWSTR optional -> "buffer"
// lpHostName : LPCWSTR optional -> "buffer"
// lpComputerName : LPCWSTR optional -> "buffer"
// dwFlags : DWORD -> "u32"
// pGPOList : GROUP_POLICY_OBJECTW** out -> "pointer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t GetGPOListW(
    void* hToken,
    const uint16_t* lpName,
    const uint16_t* lpHostName,
    const uint16_t* lpComputerName,
    uint32_t dwFlags,
    void* pGPOList);
C, "USERENV.dll");
// $ffi->GetGPOListW(hToken, lpName, lpHostName, lpComputerName, dwFlags, pGPOList);
// hToken : HANDLE optional
// lpName : LPCWSTR optional
// lpHostName : LPCWSTR optional
// lpComputerName : LPCWSTR optional
// dwFlags : DWORD
// pGPOList : GROUP_POLICY_OBJECTW** out
// 構造体/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 Userenv extends StdCallLibrary {
    Userenv INSTANCE = Native.load("userenv", Userenv.class, W32APIOptions.UNICODE_OPTIONS);
    boolean GetGPOListW(
        Pointer hToken,   // HANDLE optional
        WString lpName,   // LPCWSTR optional
        WString lpHostName,   // LPCWSTR optional
        WString lpComputerName,   // LPCWSTR optional
        int dwFlags,   // DWORD
        Pointer pGPOList   // GROUP_POLICY_OBJECTW** out
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("userenv")]
lib LibUSERENV
  fun GetGPOListW = GetGPOListW(
    hToken : Void*,   # HANDLE optional
    lpName : UInt16*,   # LPCWSTR optional
    lpHostName : UInt16*,   # LPCWSTR optional
    lpComputerName : UInt16*,   # LPCWSTR optional
    dwFlags : UInt32,   # DWORD
    pGPOList : GROUP_POLICY_OBJECTW**   # GROUP_POLICY_OBJECTW** out
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef GetGPOListWNative = Int32 Function(Pointer<Void>, Pointer<Utf16>, Pointer<Utf16>, Pointer<Utf16>, Uint32, Pointer<Void>);
typedef GetGPOListWDart = int Function(Pointer<Void>, Pointer<Utf16>, Pointer<Utf16>, Pointer<Utf16>, int, Pointer<Void>);
final GetGPOListW = DynamicLibrary.open('USERENV.dll')
    .lookupFunction<GetGPOListWNative, GetGPOListWDart>('GetGPOListW');
// hToken : HANDLE optional -> Pointer<Void>
// lpName : LPCWSTR optional -> Pointer<Utf16>
// lpHostName : LPCWSTR optional -> Pointer<Utf16>
// lpComputerName : LPCWSTR optional -> Pointer<Utf16>
// dwFlags : DWORD -> Uint32
// pGPOList : GROUP_POLICY_OBJECTW** out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
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';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "GetGPOListW"
  c_GetGPOListW :: Ptr () -> CWString -> CWString -> CWString -> Word32 -> Ptr () -> IO CInt
-- hToken : HANDLE optional -> Ptr ()
-- lpName : LPCWSTR optional -> CWString
-- lpHostName : LPCWSTR optional -> CWString
-- lpComputerName : LPCWSTR optional -> CWString
-- dwFlags : DWORD -> Word32
-- pGPOList : GROUP_POLICY_OBJECTW** out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let getgpolistw =
  foreign "GetGPOListW"
    ((ptr void) @-> (ptr uint16_t) @-> (ptr uint16_t) @-> (ptr uint16_t) @-> uint32_t @-> (ptr void) @-> returning int32_t)
(* hToken : HANDLE optional -> (ptr void) *)
(* lpName : LPCWSTR optional -> (ptr uint16_t) *)
(* lpHostName : LPCWSTR optional -> (ptr uint16_t) *)
(* lpComputerName : LPCWSTR optional -> (ptr uint16_t) *)
(* dwFlags : DWORD -> uint32_t *)
(* pGPOList : GROUP_POLICY_OBJECTW** out -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library userenv (t "USERENV.dll"))
(cffi:use-foreign-library userenv)

(cffi:defcfun ("GetGPOListW" get-gpolist-w :convention :stdcall) :int32
  (h-token :pointer)   ; HANDLE optional
  (lp-name (:string :encoding :utf-16le))   ; LPCWSTR optional
  (lp-host-name (:string :encoding :utf-16le))   ; LPCWSTR optional
  (lp-computer-name (:string :encoding :utf-16le))   ; LPCWSTR optional
  (dw-flags :uint32)   ; DWORD
  (p-gpolist :pointer))   ; GROUP_POLICY_OBJECTW** out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $GetGPOListW = Win32::API::More->new('USERENV',
    'BOOL GetGPOListW(HANDLE hToken, LPCWSTR lpName, LPCWSTR lpHostName, LPCWSTR lpComputerName, DWORD dwFlags, LPVOID pGPOList)');
# my $ret = $GetGPOListW->Call($hToken, $lpName, $lpHostName, $lpComputerName, $dwFlags, $pGPOList);
# hToken : HANDLE optional -> HANDLE
# lpName : LPCWSTR optional -> LPCWSTR
# lpHostName : LPCWSTR optional -> LPCWSTR
# lpComputerName : LPCWSTR optional -> LPCWSTR
# dwFlags : DWORD -> DWORD
# pGPOList : GROUP_POLICY_OBJECTW** out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

文字セット違い
使用する型