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

GetAppliedGPOListW

関数
適用済みGPOの一覧を取得する(Unicode版)。
DLLUSERENV.dll文字セットUnicode (-W)呼出規約winapi対応OSWindows Vista 以降

シグネチャ

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

DWORD GetAppliedGPOListW(
    DWORD dwFlags,
    LPCWSTR pMachineName,   // optional
    PSID pSidUser,   // optional
    GUID* pGuidExtension,
    GROUP_POLICY_OBJECTW** ppGPOList
);

パラメーター

名前方向説明
dwFlagsDWORDin取得対象を示すフラグ。GPO_LIST_FLAG_MACHINEでマシン、未指定でユーザーを対象とする。
pMachineNameLPCWSTRinoptional対象コンピューター名(Unicode)。NULL可でローカルを使う。
pSidUserPSIDinoptional対象ユーザーのSID。マシン側取得時はNULL可。
pGuidExtensionGUID*in適用結果を取得するCSE(クライアント側拡張)のGUID。
ppGPOListGROUP_POLICY_OBJECTW**out適用されたGPOの連結リスト(GROUP_POLICY_OBJECTW)を受け取る出力ポインタ。

戻り値の型: DWORD

各言語での呼び出し定義

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

DWORD GetAppliedGPOListW(
    DWORD dwFlags,
    LPCWSTR pMachineName,   // optional
    PSID pSidUser,   // optional
    GUID* pGuidExtension,
    GROUP_POLICY_OBJECTW** ppGPOList
);
[DllImport("USERENV.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern uint GetAppliedGPOListW(
    uint dwFlags,   // DWORD
    [MarshalAs(UnmanagedType.LPWStr)] string pMachineName,   // LPCWSTR optional
    IntPtr pSidUser,   // PSID optional
    ref Guid pGuidExtension,   // GUID*
    IntPtr ppGPOList   // GROUP_POLICY_OBJECTW** out
);
<DllImport("USERENV.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function GetAppliedGPOListW(
    dwFlags As UInteger,   ' DWORD
    <MarshalAs(UnmanagedType.LPWStr)> pMachineName As String,   ' LPCWSTR optional
    pSidUser As IntPtr,   ' PSID optional
    ByRef pGuidExtension As Guid,   ' GUID*
    ppGPOList As IntPtr   ' GROUP_POLICY_OBJECTW** out
) As UInteger
End Function
' dwFlags : DWORD
' pMachineName : LPCWSTR optional
' pSidUser : PSID optional
' pGuidExtension : GUID*
' ppGPOList : GROUP_POLICY_OBJECTW** out
Declare PtrSafe Function GetAppliedGPOListW Lib "userenv" ( _
    ByVal dwFlags As Long, _
    ByVal pMachineName As LongPtr, _
    ByVal pSidUser As LongPtr, _
    ByVal pGuidExtension As LongPtr, _
    ByVal ppGPOList 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

GetAppliedGPOListW = ctypes.windll.userenv.GetAppliedGPOListW
GetAppliedGPOListW.restype = wintypes.DWORD
GetAppliedGPOListW.argtypes = [
    wintypes.DWORD,  # dwFlags : DWORD
    wintypes.LPCWSTR,  # pMachineName : LPCWSTR optional
    wintypes.HANDLE,  # pSidUser : PSID optional
    ctypes.c_void_p,  # pGuidExtension : GUID*
    ctypes.c_void_p,  # ppGPOList : GROUP_POLICY_OBJECTW** out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('USERENV.dll')
GetAppliedGPOListW = Fiddle::Function.new(
  lib['GetAppliedGPOListW'],
  [
    -Fiddle::TYPE_INT,  # dwFlags : DWORD
    Fiddle::TYPE_VOIDP,  # pMachineName : LPCWSTR optional
    Fiddle::TYPE_VOIDP,  # pSidUser : PSID optional
    Fiddle::TYPE_VOIDP,  # pGuidExtension : GUID*
    Fiddle::TYPE_VOIDP,  # ppGPOList : GROUP_POLICY_OBJECTW** out
  ],
  -Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "userenv")]
extern "system" {
    fn GetAppliedGPOListW(
        dwFlags: u32,  // DWORD
        pMachineName: *const u16,  // LPCWSTR optional
        pSidUser: *mut core::ffi::c_void,  // PSID optional
        pGuidExtension: *mut GUID,  // GUID*
        ppGPOList: *mut *mut GROUP_POLICY_OBJECTW  // GROUP_POLICY_OBJECTW** out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("USERENV.dll", CharSet = CharSet.Unicode)]
public static extern uint GetAppliedGPOListW(uint dwFlags, [MarshalAs(UnmanagedType.LPWStr)] string pMachineName, IntPtr pSidUser, ref Guid pGuidExtension, IntPtr ppGPOList);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USERENV_GetAppliedGPOListW' -Namespace Win32 -PassThru
# $api::GetAppliedGPOListW(dwFlags, pMachineName, pSidUser, pGuidExtension, ppGPOList)
#uselib "USERENV.dll"
#func global GetAppliedGPOListW "GetAppliedGPOListW" wptr, wptr, wptr, wptr, wptr
; GetAppliedGPOListW dwFlags, pMachineName, pSidUser, varptr(pGuidExtension), varptr(ppGPOList)   ; 戻り値は stat
; dwFlags : DWORD -> "wptr"
; pMachineName : LPCWSTR optional -> "wptr"
; pSidUser : PSID optional -> "wptr"
; pGuidExtension : GUID* -> "wptr"
; ppGPOList : GROUP_POLICY_OBJECTW** out -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "USERENV.dll"
#cfunc global GetAppliedGPOListW "GetAppliedGPOListW" int, wstr, sptr, var, var
; res = GetAppliedGPOListW(dwFlags, pMachineName, pSidUser, pGuidExtension, ppGPOList)
; dwFlags : DWORD -> "int"
; pMachineName : LPCWSTR optional -> "wstr"
; pSidUser : PSID optional -> "sptr"
; pGuidExtension : GUID* -> "var"
; ppGPOList : GROUP_POLICY_OBJECTW** out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; DWORD GetAppliedGPOListW(DWORD dwFlags, LPCWSTR pMachineName, PSID pSidUser, GUID* pGuidExtension, GROUP_POLICY_OBJECTW** ppGPOList)
#uselib "USERENV.dll"
#cfunc global GetAppliedGPOListW "GetAppliedGPOListW" int, wstr, intptr, var, var
; res = GetAppliedGPOListW(dwFlags, pMachineName, pSidUser, pGuidExtension, ppGPOList)
; dwFlags : DWORD -> "int"
; pMachineName : LPCWSTR optional -> "wstr"
; pSidUser : PSID optional -> "intptr"
; pGuidExtension : GUID* -> "var"
; ppGPOList : GROUP_POLICY_OBJECTW** out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	userenv = windows.NewLazySystemDLL("USERENV.dll")
	procGetAppliedGPOListW = userenv.NewProc("GetAppliedGPOListW")
)

// dwFlags (DWORD), pMachineName (LPCWSTR optional), pSidUser (PSID optional), pGuidExtension (GUID*), ppGPOList (GROUP_POLICY_OBJECTW** out)
r1, _, err := procGetAppliedGPOListW.Call(
	uintptr(dwFlags),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(pMachineName))),
	uintptr(pSidUser),
	uintptr(pGuidExtension),
	uintptr(ppGPOList),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD
function GetAppliedGPOListW(
  dwFlags: DWORD;   // DWORD
  pMachineName: PWideChar;   // LPCWSTR optional
  pSidUser: THandle;   // PSID optional
  pGuidExtension: PGUID;   // GUID*
  ppGPOList: Pointer   // GROUP_POLICY_OBJECTW** out
): DWORD; stdcall;
  external 'USERENV.dll' name 'GetAppliedGPOListW';
result := DllCall("USERENV\GetAppliedGPOListW"
    , "UInt", dwFlags   ; DWORD
    , "WStr", pMachineName   ; LPCWSTR optional
    , "Ptr", pSidUser   ; PSID optional
    , "Ptr", pGuidExtension   ; GUID*
    , "Ptr", ppGPOList   ; GROUP_POLICY_OBJECTW** out
    , "UInt")   ; return: DWORD
●GetAppliedGPOListW(dwFlags, pMachineName, pSidUser, pGuidExtension, ppGPOList) = DLL("USERENV.dll", "dword GetAppliedGPOListW(dword, char*, void*, void*, void*)")
# 呼び出し: GetAppliedGPOListW(dwFlags, pMachineName, pSidUser, pGuidExtension, ppGPOList)
# dwFlags : DWORD -> "dword"
# pMachineName : LPCWSTR optional -> "char*"
# pSidUser : PSID optional -> "void*"
# pGuidExtension : GUID* -> "void*"
# ppGPOList : 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 GetAppliedGPOListW(
    dwFlags: u32, // DWORD
    pMachineName: [*c]const u16, // LPCWSTR optional
    pSidUser: ?*anyopaque, // PSID optional
    pGuidExtension: [*c]GUID, // GUID*
    ppGPOList: [*c][*c]GROUP_POLICY_OBJECTW // GROUP_POLICY_OBJECTW** out
) callconv(std.os.windows.WINAPI) u32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc GetAppliedGPOListW(
    dwFlags: uint32,  # DWORD
    pMachineName: WideCString,  # LPCWSTR optional
    pSidUser: pointer,  # PSID optional
    pGuidExtension: ptr GUID,  # GUID*
    ppGPOList: ptr GROUP_POLICY_OBJECTW  # GROUP_POLICY_OBJECTW** out
): uint32 {.importc: "GetAppliedGPOListW", stdcall, dynlib: "USERENV.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "userenv");
extern(Windows)
uint GetAppliedGPOListW(
    uint dwFlags,   // DWORD
    const(wchar)* pMachineName,   // LPCWSTR optional
    void* pSidUser,   // PSID optional
    GUID* pGuidExtension,   // GUID*
    GROUP_POLICY_OBJECTW** ppGPOList   // GROUP_POLICY_OBJECTW** out
);
ccall((:GetAppliedGPOListW, "USERENV.dll"), stdcall, UInt32,
      (UInt32, Cwstring, Ptr{Cvoid}, Ptr{GUID}, Ptr{GROUP_POLICY_OBJECTW}),
      dwFlags, pMachineName, pSidUser, pGuidExtension, ppGPOList)
# dwFlags : DWORD -> UInt32
# pMachineName : LPCWSTR optional -> Cwstring
# pSidUser : PSID optional -> Ptr{Cvoid}
# pGuidExtension : GUID* -> Ptr{GUID}
# ppGPOList : GROUP_POLICY_OBJECTW** out -> Ptr{GROUP_POLICY_OBJECTW}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
uint32_t GetAppliedGPOListW(
    uint32_t dwFlags,
    const uint16_t* pMachineName,
    void* pSidUser,
    void* pGuidExtension,
    void* ppGPOList);
]]
local userenv = ffi.load("userenv")
-- userenv.GetAppliedGPOListW(dwFlags, pMachineName, pSidUser, pGuidExtension, ppGPOList)
-- dwFlags : DWORD
-- pMachineName : LPCWSTR optional
-- pSidUser : PSID optional
-- pGuidExtension : GUID*
-- ppGPOList : 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 GetAppliedGPOListW = lib.func('__stdcall', 'GetAppliedGPOListW', 'uint32_t', ['uint32_t', 'str16', 'void *', 'void *', 'void *']);
// GetAppliedGPOListW(dwFlags, pMachineName, pSidUser, pGuidExtension, ppGPOList)
// dwFlags : DWORD -> 'uint32_t'
// pMachineName : LPCWSTR optional -> 'str16'
// pSidUser : PSID optional -> 'void *'
// pGuidExtension : GUID* -> 'void *'
// ppGPOList : GROUP_POLICY_OBJECTW** out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("USERENV.dll", {
  GetAppliedGPOListW: { parameters: ["u32", "buffer", "pointer", "pointer", "pointer"], result: "u32" },
});
// lib.symbols.GetAppliedGPOListW(dwFlags, pMachineName, pSidUser, pGuidExtension, ppGPOList)
// dwFlags : DWORD -> "u32"
// pMachineName : LPCWSTR optional -> "buffer"
// pSidUser : PSID optional -> "pointer"
// pGuidExtension : GUID* -> "pointer"
// ppGPOList : GROUP_POLICY_OBJECTW** out -> "pointer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t GetAppliedGPOListW(
    uint32_t dwFlags,
    const uint16_t* pMachineName,
    void* pSidUser,
    void* pGuidExtension,
    void* ppGPOList);
C, "USERENV.dll");
// $ffi->GetAppliedGPOListW(dwFlags, pMachineName, pSidUser, pGuidExtension, ppGPOList);
// dwFlags : DWORD
// pMachineName : LPCWSTR optional
// pSidUser : PSID optional
// pGuidExtension : GUID*
// ppGPOList : 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);
    int GetAppliedGPOListW(
        int dwFlags,   // DWORD
        WString pMachineName,   // LPCWSTR optional
        Pointer pSidUser,   // PSID optional
        Pointer pGuidExtension,   // GUID*
        Pointer ppGPOList   // GROUP_POLICY_OBJECTW** out
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("userenv")]
lib LibUSERENV
  fun GetAppliedGPOListW = GetAppliedGPOListW(
    dwFlags : UInt32,   # DWORD
    pMachineName : UInt16*,   # LPCWSTR optional
    pSidUser : Void*,   # PSID optional
    pGuidExtension : GUID*,   # GUID*
    ppGPOList : GROUP_POLICY_OBJECTW**   # GROUP_POLICY_OBJECTW** out
  ) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef GetAppliedGPOListWNative = Uint32 Function(Uint32, Pointer<Utf16>, Pointer<Void>, Pointer<Void>, Pointer<Void>);
typedef GetAppliedGPOListWDart = int Function(int, Pointer<Utf16>, Pointer<Void>, Pointer<Void>, Pointer<Void>);
final GetAppliedGPOListW = DynamicLibrary.open('USERENV.dll')
    .lookupFunction<GetAppliedGPOListWNative, GetAppliedGPOListWDart>('GetAppliedGPOListW');
// dwFlags : DWORD -> Uint32
// pMachineName : LPCWSTR optional -> Pointer<Utf16>
// pSidUser : PSID optional -> Pointer<Void>
// pGuidExtension : GUID* -> Pointer<Void>
// ppGPOList : GROUP_POLICY_OBJECTW** out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function GetAppliedGPOListW(
  dwFlags: DWORD;   // DWORD
  pMachineName: PWideChar;   // LPCWSTR optional
  pSidUser: THandle;   // PSID optional
  pGuidExtension: PGUID;   // GUID*
  ppGPOList: Pointer   // GROUP_POLICY_OBJECTW** out
): DWORD; stdcall;
  external 'USERENV.dll' name 'GetAppliedGPOListW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "GetAppliedGPOListW"
  c_GetAppliedGPOListW :: Word32 -> CWString -> Ptr () -> Ptr () -> Ptr () -> IO Word32
-- dwFlags : DWORD -> Word32
-- pMachineName : LPCWSTR optional -> CWString
-- pSidUser : PSID optional -> Ptr ()
-- pGuidExtension : GUID* -> Ptr ()
-- ppGPOList : GROUP_POLICY_OBJECTW** out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let getappliedgpolistw =
  foreign "GetAppliedGPOListW"
    (uint32_t @-> (ptr uint16_t) @-> (ptr void) @-> (ptr void) @-> (ptr void) @-> returning uint32_t)
(* dwFlags : DWORD -> uint32_t *)
(* pMachineName : LPCWSTR optional -> (ptr uint16_t) *)
(* pSidUser : PSID optional -> (ptr void) *)
(* pGuidExtension : GUID* -> (ptr void) *)
(* ppGPOList : 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 ("GetAppliedGPOListW" get-applied-gpolist-w :convention :stdcall) :uint32
  (dw-flags :uint32)   ; DWORD
  (p-machine-name (:string :encoding :utf-16le))   ; LPCWSTR optional
  (p-sid-user :pointer)   ; PSID optional
  (p-guid-extension :pointer)   ; GUID*
  (pp-gpolist :pointer))   ; GROUP_POLICY_OBJECTW** out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $GetAppliedGPOListW = Win32::API::More->new('USERENV',
    'DWORD GetAppliedGPOListW(DWORD dwFlags, LPCWSTR pMachineName, HANDLE pSidUser, LPVOID pGuidExtension, LPVOID ppGPOList)');
# my $ret = $GetAppliedGPOListW->Call($dwFlags, $pMachineName, $pSidUser, $pGuidExtension, $ppGPOList);
# dwFlags : DWORD -> DWORD
# pMachineName : LPCWSTR optional -> LPCWSTR
# pSidUser : PSID optional -> HANDLE
# pGuidExtension : GUID* -> LPVOID
# ppGPOList : GROUP_POLICY_OBJECTW** out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

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