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

FreeGPOListA

関数
取得したGPOリストを解放する(ANSI版)。
DLLUSERENV.dll文字セットANSI (-A)呼出規約winapiSetLastErrorあり対応OSWindows Vista 以降
📘 Microsoft Learn (日本語) · English

シグネチャ

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

BOOL FreeGPOListA(
    GROUP_POLICY_OBJECTA* pGPOList
);

パラメーター

名前型方向説明
pGPOListGROUP_POLICY_OBJECTA*inGetGPOListAで取得したGPOリストの先頭ポインタ。メモリを解放する。

戻り値の型: BOOL

各言語での呼び出し定義

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

BOOL FreeGPOListA(
    GROUP_POLICY_OBJECTA* pGPOList
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("USERENV.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern bool FreeGPOListA(
    IntPtr pGPOList   // GROUP_POLICY_OBJECTA*
);
<DllImport("USERENV.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function FreeGPOListA(
    pGPOList As IntPtr   ' GROUP_POLICY_OBJECTA*
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' pGPOList : GROUP_POLICY_OBJECTA*
Declare PtrSafe Function FreeGPOListA Lib "userenv" ( _
    ByVal pGPOList As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

FreeGPOListA = ctypes.windll.userenv.FreeGPOListA
FreeGPOListA.restype = wintypes.BOOL
FreeGPOListA.argtypes = [
    ctypes.c_void_p,  # pGPOList : GROUP_POLICY_OBJECTA*
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('USERENV.dll')
FreeGPOListA = Fiddle::Function.new(
  lib['FreeGPOListA'],
  [
    Fiddle::TYPE_VOIDP,  # pGPOList : GROUP_POLICY_OBJECTA*
  ],
  Fiddle::TYPE_INT)
#[link(name = "userenv")]
extern "system" {
    fn FreeGPOListA(
        pGPOList: *mut GROUP_POLICY_OBJECTA  // GROUP_POLICY_OBJECTA*
    ) -> 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 FreeGPOListA(IntPtr pGPOList);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USERENV_FreeGPOListA' -Namespace Win32 -PassThru
# $api::FreeGPOListA(pGPOList)
#uselib "USERENV.dll"
#func global FreeGPOListA "FreeGPOListA" sptr
; FreeGPOListA varptr(pGPOList)   ; 戻り値は stat
; pGPOList : GROUP_POLICY_OBJECTA* -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数: 
#uselib "USERENV.dll"
#cfunc global FreeGPOListA "FreeGPOListA" var
; res = FreeGPOListA(pGPOList)
; pGPOList : GROUP_POLICY_OBJECTA* -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数: 
; BOOL FreeGPOListA(GROUP_POLICY_OBJECTA* pGPOList)
#uselib "USERENV.dll"
#cfunc global FreeGPOListA "FreeGPOListA" var
; res = FreeGPOListA(pGPOList)
; pGPOList : GROUP_POLICY_OBJECTA* -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	userenv = windows.NewLazySystemDLL("USERENV.dll")
	procFreeGPOListA = userenv.NewProc("FreeGPOListA")
)

// pGPOList (GROUP_POLICY_OBJECTA*)
r1, _, err := procFreeGPOListA.Call(
	uintptr(pGPOList),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function FreeGPOListA(
  pGPOList: Pointer   // GROUP_POLICY_OBJECTA*
): BOOL; stdcall;
  external 'USERENV.dll' name 'FreeGPOListA';
result := DllCall("USERENV\FreeGPOListA"
    , "Ptr", pGPOList   ; GROUP_POLICY_OBJECTA*
    , "Int")   ; return: BOOL
●FreeGPOListA(pGPOList) = DLL("USERENV.dll", "bool FreeGPOListA(void*)")
# 呼び出し: FreeGPOListA(pGPOList)
# pGPOList : GROUP_POLICY_OBJECTA* -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "userenv" fn FreeGPOListA(
    pGPOList: [*c]GROUP_POLICY_OBJECTA // GROUP_POLICY_OBJECTA*
) callconv(std.os.windows.WINAPI) i32;
proc FreeGPOListA(
    pGPOList: ptr GROUP_POLICY_OBJECTA  # GROUP_POLICY_OBJECTA*
): int32 {.importc: "FreeGPOListA", stdcall, dynlib: "USERENV.dll".}
pragma(lib, "userenv");
extern(Windows)
int FreeGPOListA(
    GROUP_POLICY_OBJECTA* pGPOList   // GROUP_POLICY_OBJECTA*
);
ccall((:FreeGPOListA, "USERENV.dll"), stdcall, Int32,
      (Ptr{GROUP_POLICY_OBJECTA},),
      pGPOList)
# pGPOList : GROUP_POLICY_OBJECTA* -> Ptr{GROUP_POLICY_OBJECTA}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t FreeGPOListA(
    void* pGPOList);
]]
local userenv = ffi.load("userenv")
-- userenv.FreeGPOListA(pGPOList)
-- pGPOList : GROUP_POLICY_OBJECTA*
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('USERENV.dll');
const FreeGPOListA = lib.func('__stdcall', 'FreeGPOListA', 'int32_t', ['void *']);
// FreeGPOListA(pGPOList)
// pGPOList : GROUP_POLICY_OBJECTA* -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("USERENV.dll", {
  FreeGPOListA: { parameters: ["pointer"], result: "i32" },
});
// lib.symbols.FreeGPOListA(pGPOList)
// pGPOList : GROUP_POLICY_OBJECTA* -> "pointer"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t FreeGPOListA(
    void* pGPOList);
C, "USERENV.dll");
// $ffi->FreeGPOListA(pGPOList);
// pGPOList : GROUP_POLICY_OBJECTA*
// 構造体/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 FreeGPOListA(
        Pointer pGPOList   // GROUP_POLICY_OBJECTA*
    );
}
@[Link("userenv")]
lib LibUSERENV
  fun FreeGPOListA = FreeGPOListA(
    pGPOList : GROUP_POLICY_OBJECTA*   # GROUP_POLICY_OBJECTA*
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef FreeGPOListANative = Int32 Function(Pointer<Void>);
typedef FreeGPOListADart = int Function(Pointer<Void>);
final FreeGPOListA = DynamicLibrary.open('USERENV.dll')
    .lookupFunction<FreeGPOListANative, FreeGPOListADart>('FreeGPOListA');
// pGPOList : GROUP_POLICY_OBJECTA* -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function FreeGPOListA(
  pGPOList: Pointer   // GROUP_POLICY_OBJECTA*
): BOOL; stdcall;
  external 'USERENV.dll' name 'FreeGPOListA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "FreeGPOListA"
  c_FreeGPOListA :: Ptr () -> IO CInt
-- pGPOList : GROUP_POLICY_OBJECTA* -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let freegpolista =
  foreign "FreeGPOListA"
    ((ptr void) @-> returning int32_t)
(* pGPOList : GROUP_POLICY_OBJECTA* -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library userenv (t "USERENV.dll"))
(cffi:use-foreign-library userenv)

(cffi:defcfun ("FreeGPOListA" free-gpolist-a :convention :stdcall) :int32
  (p-gpolist :pointer))   ; GROUP_POLICY_OBJECTA*
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $FreeGPOListA = Win32::API::More->new('USERENV',
    'BOOL FreeGPOListA(LPVOID pGPOList)');
# my $ret = $FreeGPOListA->Call($pGPOList);
# pGPOList : GROUP_POLICY_OBJECTA* -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

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