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

LocalUnlock

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

シグネチャ

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

BOOL LocalUnlock(
    HLOCAL hMem
);

パラメーター

名前方向説明
hMemHLOCALinローカルメモリオブジェクトへのハンドル。このハンドルは LocalAlloc 関数または LocalReAlloc 関数によって返されます。

戻り値の型: BOOL

公式ドキュメント

LMEM_MOVEABLE で割り当てられたメモリオブジェクトに関連付けられたロックカウントをデクリメントします。

戻り値

ロックカウントをデクリメントした後もメモリオブジェクトがロックされている場合、戻り値は 0 以外になります。ロックカウントをデクリメントした後にメモリオブジェクトがロック解除された場合、関数は 0 を返し、GetLastErrorNO_ERROR を返します。

関数が失敗した場合、戻り値は 0 になり、 GetLastErrorNO_ERROR 以外の値を返します。

解説(Remarks)

各メモリオブジェクトの内部データ構造には、初期値が 0 のロックカウントが含まれています。移動可能なメモリオブジェクトの場合、 LocalLock 関数はカウントを 1 増やし、 LocalUnlock はカウントを 1 減らします。プロセスがあるオブジェクトに対して LocalLock を呼び出すたびに、最終的に LocalUnlock を呼び出す必要があります。ロックされたメモリは、 LocalReAlloc 関数によってメモリオブジェクトが再割り当てされない限り、移動または破棄されません。ロックされたメモリオブジェクトのメモリブロックは、ロックカウントが 0 までデクリメントされるまでロックされたままで、0 になった時点で移動または破棄が可能になります。

メモリオブジェクトが既にロック解除されている場合、 LocalUnlockFALSE を返し、GetLastErrorERROR_NOT_LOCKED を報告します。LMEM_FIXED で割り当てられたメモリオブジェクトは常にロックカウントが 0 であり、ERROR_NOT_LOCKED エラーを引き起こします。

プロセスは、その後 LocalUnlock を呼び出す必要がある回数を判断するために戻り値に依存すべきではありません。

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

各言語での呼び出し定義

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

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

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

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

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procLocalUnlock = kernel32.NewProc("LocalUnlock")
)

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

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

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

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

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

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

関連項目

公式の関連項目