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

パラメーター

名前	型	方向	説明
hToken	HANDLE	inoptional	対象ユーザーのアクセストークンのハンドル。NULL可で現在のユーザーを使う。
lpName	LPCSTR	inoptional	ユーザーまたはコンピューターのLDAP識別名(ANSI)。NULL可。
lpHostName	LPCSTR	inoptional	ドメインのDNS名(ANSI)。NULL可。
lpComputerName	LPCSTR	inoptional	対象コンピューター名(ANSI)。NULL可でローカルを使う。
dwFlags	DWORD	in	GPO収集の対象や挙動を示すフラグ。マシン/ユーザーやループバック等を指定する。
pGPOList	GROUP_POLICY_OBJECTA**	out	適用GPOの連結リスト(GROUP_POLICY_OBJECTA)の先頭を受け取る出力ポインタ。

戻り値の型: 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 <MarshalAs(UnmanagedType.Bool)> 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 方式にも切替可。#uselib "USERENV.dll"
#cfunc global GetGPOListA "GetGPOListA" sptr, str, str, str, int, sptr
; res = GetGPOListA(hToken, lpName, lpHostName, lpComputerName, dwFlags, varptr(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 -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは 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 方式にも切替可。; 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, intptr
; res = GetGPOListA(hToken, lpName, lpHostName, lpComputerName, dwFlags, varptr(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 -> "intptr"
; ※出力/バッファ引数はポインタ方式(token=intptr / 呼び出しは 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)。

const std = @import("std");

extern "userenv" fn GetGPOListA(
    hToken: ?*anyopaque, // HANDLE optional
    lpName: [*c]const u8, // LPCSTR optional
    lpHostName: [*c]const u8, // LPCSTR optional
    lpComputerName: [*c]const u8, // LPCSTR optional
    dwFlags: u32, // DWORD
    pGPOList: [*c][*c]GROUP_POLICY_OBJECTA // GROUP_POLICY_OBJECTA** out
) callconv(std.os.windows.WINAPI) i32;

proc GetGPOListA(
    hToken: pointer,  # HANDLE optional
    lpName: cstring,  # LPCSTR optional
    lpHostName: cstring,  # LPCSTR optional
    lpComputerName: cstring,  # LPCSTR optional
    dwFlags: uint32,  # DWORD
    pGPOList: ptr GROUP_POLICY_OBJECTA  # GROUP_POLICY_OBJECTA** out
): int32 {.importc: "GetGPOListA", stdcall, dynlib: "USERENV.dll".}

pragma(lib, "userenv");
extern(Windows)
int GetGPOListA(
    void* hToken,   // HANDLE optional
    const(char)* lpName,   // LPCSTR optional
    const(char)* lpHostName,   // LPCSTR optional
    const(char)* lpComputerName,   // LPCSTR optional
    uint dwFlags,   // DWORD
    GROUP_POLICY_OBJECTA** pGPOList   // GROUP_POLICY_OBJECTA** out
);

ccall((:GetGPOListA, "USERENV.dll"), stdcall, Int32,
      (Ptr{Cvoid}, Cstring, Cstring, Cstring, UInt32, Ptr{GROUP_POLICY_OBJECTA}),
      hToken, lpName, lpHostName, lpComputerName, dwFlags, pGPOList)
# hToken : HANDLE optional -> Ptr{Cvoid}
# lpName : LPCSTR optional -> Cstring
# lpHostName : LPCSTR optional -> Cstring
# lpComputerName : LPCSTR optional -> Cstring
# dwFlags : DWORD -> UInt32
# pGPOList : GROUP_POLICY_OBJECTA** out -> Ptr{GROUP_POLICY_OBJECTA}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。

local ffi = require("ffi")
ffi.cdef[[
int32_t GetGPOListA(
    void* hToken,
    const char* lpName,
    const char* lpHostName,
    const char* lpComputerName,
    uint32_t dwFlags,
    void* pGPOList);
]]
local userenv = ffi.load("userenv")
-- userenv.GetGPOListA(hToken, lpName, lpHostName, lpComputerName, dwFlags, pGPOList)
-- hToken : HANDLE optional
-- lpName : LPCSTR optional
-- lpHostName : LPCSTR optional
-- lpComputerName : LPCSTR optional
-- dwFlags : DWORD
-- pGPOList : GROUP_POLICY_OBJECTA** out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。

const koffi = require('koffi');
const lib = koffi.load('USERENV.dll');
const GetGPOListA = lib.func('__stdcall', 'GetGPOListA', 'int32_t', ['void *', 'str', 'str', 'str', 'uint32_t', 'void *']);
// GetGPOListA(hToken, lpName, lpHostName, lpComputerName, dwFlags, pGPOList)
// hToken : HANDLE optional -> 'void *'
// lpName : LPCSTR optional -> 'str'
// lpHostName : LPCSTR optional -> 'str'
// lpComputerName : LPCSTR optional -> 'str'
// dwFlags : DWORD -> 'uint32_t'
// pGPOList : GROUP_POLICY_OBJECTA** out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。

const lib = Deno.dlopen("USERENV.dll", {
  GetGPOListA: { parameters: ["pointer", "buffer", "buffer", "buffer", "u32", "pointer"], result: "i32" },
});
// lib.symbols.GetGPOListA(hToken, lpName, lpHostName, lpComputerName, dwFlags, pGPOList)
// hToken : HANDLE optional -> "pointer"
// lpName : LPCSTR optional -> "buffer"
// lpHostName : LPCSTR optional -> "buffer"
// lpComputerName : LPCSTR optional -> "buffer"
// dwFlags : DWORD -> "u32"
// pGPOList : GROUP_POLICY_OBJECTA** out -> "pointer"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。

<?php
$ffi = FFI::cdef(<<<C
int32_t GetGPOListA(
    void* hToken,
    const char* lpName,
    const char* lpHostName,
    const char* lpComputerName,
    uint32_t dwFlags,
    void* pGPOList);
C, "USERENV.dll");
// $ffi->GetGPOListA(hToken, lpName, lpHostName, lpComputerName, dwFlags, pGPOList);
// hToken : HANDLE optional
// lpName : LPCSTR optional
// lpHostName : LPCSTR optional
// lpComputerName : LPCSTR optional
// dwFlags : DWORD
// pGPOList : GROUP_POLICY_OBJECTA** 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.ASCII_OPTIONS);
    boolean GetGPOListA(
        Pointer hToken,   // HANDLE optional
        String lpName,   // LPCSTR optional
        String lpHostName,   // LPCSTR optional
        String lpComputerName,   // LPCSTR optional
        int dwFlags,   // DWORD
        Pointer pGPOList   // GROUP_POLICY_OBJECTA** out
    );
}

@[Link("userenv")]
lib LibUSERENV
  fun GetGPOListA = GetGPOListA(
    hToken : Void*,   # HANDLE optional
    lpName : UInt8*,   # LPCSTR optional
    lpHostName : UInt8*,   # LPCSTR optional
    lpComputerName : UInt8*,   # LPCSTR optional
    dwFlags : UInt32,   # DWORD
    pGPOList : GROUP_POLICY_OBJECTA**   # GROUP_POLICY_OBJECTA** out
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。

import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef GetGPOListANative = Int32 Function(Pointer<Void>, Pointer<Utf8>, Pointer<Utf8>, Pointer<Utf8>, Uint32, Pointer<Void>);
typedef GetGPOListADart = int Function(Pointer<Void>, Pointer<Utf8>, Pointer<Utf8>, Pointer<Utf8>, int, Pointer<Void>);
final GetGPOListA = DynamicLibrary.open('USERENV.dll')
    .lookupFunction<GetGPOListANative, GetGPOListADart>('GetGPOListA');
// hToken : HANDLE optional -> Pointer<Void>
// lpName : LPCSTR optional -> Pointer<Utf8>
// lpHostName : LPCSTR optional -> Pointer<Utf8>
// lpComputerName : LPCSTR optional -> Pointer<Utf8>
// dwFlags : DWORD -> Uint32
// pGPOList : GROUP_POLICY_OBJECTA** out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。

{$mode objfpc}{$H+}
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';

import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "GetGPOListA"
  c_GetGPOListA :: Ptr () -> CString -> CString -> CString -> Word32 -> Ptr () -> IO CInt
-- hToken : HANDLE optional -> Ptr ()
-- lpName : LPCSTR optional -> CString
-- lpHostName : LPCSTR optional -> CString
-- lpComputerName : LPCSTR optional -> CString
-- dwFlags : DWORD -> Word32
-- pGPOList : GROUP_POLICY_OBJECTA** out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。

open Ctypes
open Foreign

let getgpolista =
  foreign "GetGPOListA"
    ((ptr void) @-> string @-> string @-> string @-> uint32_t @-> (ptr void) @-> returning int32_t)
(* hToken : HANDLE optional -> (ptr void) *)
(* lpName : LPCSTR optional -> string *)
(* lpHostName : LPCSTR optional -> string *)
(* lpComputerName : LPCSTR optional -> string *)
(* dwFlags : DWORD -> uint32_t *)
(* pGPOList : GROUP_POLICY_OBJECTA** 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 ("GetGPOListA" get-gpolist-a :convention :stdcall) :int32
  (h-token :pointer)   ; HANDLE optional
  (lp-name :string)   ; LPCSTR optional
  (lp-host-name :string)   ; LPCSTR optional
  (lp-computer-name :string)   ; LPCSTR optional
  (dw-flags :uint32)   ; DWORD
  (p-gpolist :pointer))   ; GROUP_POLICY_OBJECTA** out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。

use Win32::API;
my $GetGPOListA = Win32::API::More->new('USERENV',
    'BOOL GetGPOListA(HANDLE hToken, LPCSTR lpName, LPCSTR lpHostName, LPCSTR lpComputerName, DWORD dwFlags, LPVOID pGPOList)');
# my $ret = $GetGPOListA->Call($hToken, $lpName, $lpHostName, $lpComputerName, $dwFlags, $pGPOList);
# hToken : HANDLE optional -> HANDLE
# lpName : LPCSTR optional -> LPCSTR
# lpHostName : LPCSTR optional -> LPCSTR
# lpComputerName : LPCSTR optional -> LPCSTR
# dwFlags : DWORD -> DWORD
# pGPOList : GROUP_POLICY_OBJECTA** out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

GetGPOListA

シグネチャ

パラメーター

各言語での呼び出し定義

関連項目