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

FreeEnvironmentStringsW

関数
取得した環境ブロックのメモリを解放する(Unicode版)。
DLLKERNEL32.dll文字セットUnicode (-W)呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

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

BOOL FreeEnvironmentStringsW(
    LPWSTR penv
);

パラメーター

名前方向説明
penvLPWSTRinGetEnvironmentStringsで取得したUnicode環境ブロックへのポインタ。解放対象。

戻り値の型: BOOL

各言語での呼び出し定義

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

BOOL FreeEnvironmentStringsW(
    LPWSTR penv
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern bool FreeEnvironmentStringsW(
    [MarshalAs(UnmanagedType.LPWStr)] string penv   // LPWSTR
);
<DllImport("KERNEL32.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function FreeEnvironmentStringsW(
    <MarshalAs(UnmanagedType.LPWStr)> penv As String   ' LPWSTR
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' penv : LPWSTR
Declare PtrSafe Function FreeEnvironmentStringsW Lib "kernel32" ( _
    ByVal penv 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

FreeEnvironmentStringsW = ctypes.windll.kernel32.FreeEnvironmentStringsW
FreeEnvironmentStringsW.restype = wintypes.BOOL
FreeEnvironmentStringsW.argtypes = [
    wintypes.LPCWSTR,  # penv : LPWSTR
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
FreeEnvironmentStringsW = Fiddle::Function.new(
  lib['FreeEnvironmentStringsW'],
  [
    Fiddle::TYPE_VOIDP,  # penv : LPWSTR
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "kernel32")]
extern "system" {
    fn FreeEnvironmentStringsW(
        penv: *mut u16  // LPWSTR
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", CharSet = CharSet.Unicode, SetLastError = true)]
public static extern bool FreeEnvironmentStringsW([MarshalAs(UnmanagedType.LPWStr)] string penv);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_FreeEnvironmentStringsW' -Namespace Win32 -PassThru
# $api::FreeEnvironmentStringsW(penv)
#uselib "KERNEL32.dll"
#func global FreeEnvironmentStringsW "FreeEnvironmentStringsW" wptr
; FreeEnvironmentStringsW penv   ; 戻り値は stat
; penv : LPWSTR -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "KERNEL32.dll"
#cfunc global FreeEnvironmentStringsW "FreeEnvironmentStringsW" wstr
; res = FreeEnvironmentStringsW(penv)
; penv : LPWSTR -> "wstr"
; BOOL FreeEnvironmentStringsW(LPWSTR penv)
#uselib "KERNEL32.dll"
#cfunc global FreeEnvironmentStringsW "FreeEnvironmentStringsW" wstr
; res = FreeEnvironmentStringsW(penv)
; penv : LPWSTR -> "wstr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procFreeEnvironmentStringsW = kernel32.NewProc("FreeEnvironmentStringsW")
)

// penv (LPWSTR)
r1, _, err := procFreeEnvironmentStringsW.Call(
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(penv))),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function FreeEnvironmentStringsW(
  penv: PWideChar   // LPWSTR
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'FreeEnvironmentStringsW';
result := DllCall("KERNEL32\FreeEnvironmentStringsW"
    , "WStr", penv   ; LPWSTR
    , "Int")   ; return: BOOL
●FreeEnvironmentStringsW(penv) = DLL("KERNEL32.dll", "bool FreeEnvironmentStringsW(char*)")
# 呼び出し: FreeEnvironmentStringsW(penv)
# penv : LPWSTR -> "char*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。
const std = @import("std");

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

typedef FreeEnvironmentStringsWNative = Int32 Function(Pointer<Utf16>);
typedef FreeEnvironmentStringsWDart = int Function(Pointer<Utf16>);
final FreeEnvironmentStringsW = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<FreeEnvironmentStringsWNative, FreeEnvironmentStringsWDart>('FreeEnvironmentStringsW');
// penv : LPWSTR -> Pointer<Utf16>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function FreeEnvironmentStringsW(
  penv: PWideChar   // LPWSTR
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'FreeEnvironmentStringsW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "FreeEnvironmentStringsW"
  c_FreeEnvironmentStringsW :: CWString -> IO CInt
-- penv : LPWSTR -> CWString
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let freeenvironmentstringsw =
  foreign "FreeEnvironmentStringsW"
    ((ptr uint16_t) @-> returning int32_t)
(* penv : LPWSTR -> (ptr uint16_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)

(cffi:defcfun ("FreeEnvironmentStringsW" free-environment-strings-w :convention :stdcall) :int32
  (penv (:string :encoding :utf-16le)))   ; LPWSTR
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $FreeEnvironmentStringsW = Win32::API::More->new('KERNEL32',
    'BOOL FreeEnvironmentStringsW(LPCWSTR penv)');
# my $ret = $FreeEnvironmentStringsW->Call($penv);
# penv : LPWSTR -> LPCWSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

文字セット違い