Win32 API 日本語リファレンス
ホームFoundation › LocalFree

LocalFree

関数
ローカルメモリオブジェクトを解放する。
DLLKERNEL32.dll呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

// KERNEL32.dll
#include <windows.h>

HLOCAL LocalFree(
    HLOCAL hMem   // optional
);

パラメーター

名前方向説明
hMemHLOCALinoptionalローカルメモリオブジェクトへのハンドルです。このハンドルは LocalAlloc または LocalReAlloc 関数によって返されます。GlobalAlloc で割り当てられたメモリを解放することは安全ではありません。

戻り値の型: HLOCAL

公式ドキュメント

指定されたローカルメモリオブジェクトを解放し、そのハンドルを無効化します。

戻り値

関数が成功した場合、戻り値は NULL です。

関数が失敗した場合、戻り値はローカルメモリオブジェクトへのハンドルと等しくなります。拡張エラー情報を取得するには、 GetLastError を呼び出してください。

解説(Remarks)

プロセスがメモリを解放した後にそのメモリを参照または変更しようとすると、ヒープの破損が発生したり、アクセス違反例外 (EXCEPTION_ACCESS_VIOLATION) が生成されたりする可能性があります。

hMem パラメーターが NULL の場合、 LocalFree はそのパラメーターを無視して NULL を返します。

LocalFree 関数はロックされたメモリオブジェクトを解放します。ロックされたメモリオブジェクトはロックカウントが 0 より大きい状態です。 LocalLock 関数はローカルメモリオブジェクトをロックし、ロックカウントを 1 増やします。 LocalUnlock 関数はそれをアンロックし、ロックカウントを 1 減らします。ローカルメモリオブジェクトのロックカウントを取得するには、 LocalFlags 関数を使用してください。

アプリケーションがシステムのデバッグ バージョン上で実行されている場合、 LocalFree はロックされたオブジェクトが解放されようとしていることを知らせるメッセージを発行します。アプリケーションをデバッグしている場合、 LocalFree はロックされたオブジェクトを解放する直前にブレークポイントに入ります。これにより、意図した動作を確認してから実行を続行できます。

例については、 LocalAlloc を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// KERNEL32.dll
#include <windows.h>

HLOCAL LocalFree(
    HLOCAL hMem   // optional
);
[DllImport("KERNEL32.dll", SetLastError = true, ExactSpelling = true)]
static extern IntPtr LocalFree(
    IntPtr hMem   // HLOCAL optional
);
<DllImport("KERNEL32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function LocalFree(
    hMem As IntPtr   ' HLOCAL optional
) As IntPtr
End Function
' hMem : HLOCAL optional
Declare PtrSafe Function LocalFree Lib "kernel32" ( _
    ByVal hMem As LongPtr) As LongPtr
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

LocalFree = ctypes.windll.kernel32.LocalFree
LocalFree.restype = ctypes.c_void_p
LocalFree.argtypes = [
    wintypes.HANDLE,  # hMem : HLOCAL optional
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
LocalFree = Fiddle::Function.new(
  lib['LocalFree'],
  [
    Fiddle::TYPE_VOIDP,  # hMem : HLOCAL optional
  ],
  Fiddle::TYPE_VOIDP)
#[link(name = "kernel32")]
extern "system" {
    fn LocalFree(
        hMem: *mut core::ffi::c_void  // HLOCAL optional
    ) -> *mut core::ffi::c_void;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("KERNEL32.dll", SetLastError = true)]
public static extern IntPtr LocalFree(IntPtr hMem);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_LocalFree' -Namespace Win32 -PassThru
# $api::LocalFree(hMem)
#uselib "KERNEL32.dll"
#func global LocalFree "LocalFree" sptr
; LocalFree hMem   ; 戻り値は stat
; hMem : HLOCAL optional -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "KERNEL32.dll"
#cfunc global LocalFree "LocalFree" sptr
; res = LocalFree(hMem)
; hMem : HLOCAL optional -> "sptr"
; HLOCAL LocalFree(HLOCAL hMem)
#uselib "KERNEL32.dll"
#cfunc global LocalFree "LocalFree" intptr
; res = LocalFree(hMem)
; hMem : HLOCAL optional -> "intptr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procLocalFree = kernel32.NewProc("LocalFree")
)

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

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

typedef LocalFreeNative = Pointer<Void> Function(Pointer<Void>);
typedef LocalFreeDart = Pointer<Void> Function(Pointer<Void>);
final LocalFree = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<LocalFreeNative, LocalFreeDart>('LocalFree');
// hMem : HLOCAL optional -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function LocalFree(
  hMem: THandle   // HLOCAL optional
): THandle; stdcall;
  external 'KERNEL32.dll' name 'LocalFree';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "LocalFree"
  c_LocalFree :: Ptr () -> IO (Ptr ())
-- hMem : HLOCAL optional -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let localfree =
  foreign "LocalFree"
    ((ptr void) @-> returning (ptr void))
(* hMem : HLOCAL optional -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)

(cffi:defcfun ("LocalFree" local-free :convention :stdcall) :pointer
  (h-mem :pointer))   ; HLOCAL optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $LocalFree = Win32::API::More->new('KERNEL32',
    'HANDLE LocalFree(HANDLE hMem)');
# my $ret = $LocalFree->Call($hMem);
# hMem : HLOCAL optional -> HANDLE
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目