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

LocalLock

関数
ローカルメモリオブジェクトをロックしポインタを取得する。
DLLKERNEL32.dll呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

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

void* LocalLock(
    HLOCAL hMem
);

パラメーター

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

戻り値の型: void*

公式ドキュメント

ローカルメモリオブジェクトをロックし、そのオブジェクトのメモリブロックの先頭バイトへのポインターを返します。

戻り値

関数が成功した場合、戻り値はメモリブロックの先頭バイトへのポインターです。

関数が失敗した場合、戻り値は NULL です。拡張エラー情報を取得するには、 GetLastError を呼び出します。

解説(Remarks)

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

LMEM_FIXED で割り当てられたメモリオブジェクトのロックカウントは常にゼロです。これらのオブジェクトでは、返されるポインターの値は指定されたハンドルの値と等しくなります。

指定されたメモリブロックが破棄されている場合、またはメモリブロックのサイズがゼロバイトの場合、この関数は NULL を返します。

破棄されたオブジェクトのロックカウントは常にゼロです。

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

各言語での呼び出し定義

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

void* LocalLock(
    HLOCAL hMem
);
[DllImport("KERNEL32.dll", SetLastError = true, ExactSpelling = true)]
static extern IntPtr LocalLock(
    IntPtr hMem   // HLOCAL
);
<DllImport("KERNEL32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function LocalLock(
    hMem As IntPtr   ' HLOCAL
) As IntPtr
End Function
' hMem : HLOCAL
Declare PtrSafe Function LocalLock 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

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

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procLocalLock = kernel32.NewProc("LocalLock")
)

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

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

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

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

let locallock =
  foreign "LocalLock"
    ((ptr void) @-> returning (ptr void))
(* 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 ("LocalLock" local-lock :convention :stdcall) :pointer
  (h-mem :pointer))   ; HLOCAL
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $LocalLock = Win32::API::More->new('KERNEL32',
    'LPVOID LocalLock(HANDLE hMem)');
# my $ret = $LocalLock->Call($hMem);
# hMem : HLOCAL -> HANDLE
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目