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

LockResource

関数
リソースをロックし先頭へのポインタを取得する。
DLLKERNEL32.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

void* LockResource(
    HGLOBAL hResData
);

パラメーター

名前方向説明
hResDataHGLOBALinアクセスするリソースへのハンドル。このハンドルは LoadResource 関数 が返します。このパラメーターが HGLOBAL 変数として記載されているのは、後方互換性のためだけであることに注意してください。LoadResource 関数が正常に返した戻り値以外の値をパラメーターとして渡さないでください。

戻り値の型: void*

公式ドキュメント

指定したリソースへのメモリ上のポインターを取得します。

戻り値

型: LPVOID

読み込まれたリソースが利用可能な場合、戻り値はリソースの先頭バイトへのポインターです。それ以外の場合は NULL になります。

解説(Remarks)

LockResource が返すポインターは、リソースを含むモジュールがアンロードされるまで有効です。リソースをアンロックする必要はありません。リソースを作成したプロセスが終了すると、システムが自動的にそれらを削除するためです。

FindResourceA 関数FindResourceExA 関数 が返すハンドルを使用してリソースをロックしようとしないでください。そのようなハンドルはランダムなデータを指します。

メモ

LockResource は実際にはメモリをロックしません。リソースデータを含むメモリへのポインターを取得するために使用されるだけです。この関数名は Windows XP より前のバージョンに由来し、当時は LoadResource によって割り当てられたグローバルメモリブロックをロックするために使用されていました。

例については、リソースの更新 を参照してください。

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

各言語での呼び出し定義

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

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

LockResource = ctypes.windll.kernel32.LockResource
LockResource.restype = ctypes.c_void_p
LockResource.argtypes = [
    wintypes.HANDLE,  # hResData : HGLOBAL
]
require 'fiddle'
require 'fiddle/import'

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

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procLockResource = kernel32.NewProc("LockResource")
)

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

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

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

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

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

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