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

LocalAlloc

関数
ローカルヒープからメモリを割り当てる。
DLLKERNEL32.dll呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

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

HLOCAL LocalAlloc(
    LOCAL_ALLOC_FLAGS uFlags,
    UINT_PTR uBytes
);

パラメーター

名前方向説明
uFlagsLOCAL_ALLOC_FLAGSin

メモリ割り当ての属性。既定値は LMEM_FIXED です。このパラメーターには、特に明記された互換性のない組み合わせを除き、次の値を 1 つ以上指定できます。

意味
LHND
0x0042
LMEM_MOVEABLELMEM_ZEROINIT を組み合わせます。
LMEM_FIXED
0x0000
固定メモリを割り当てます。戻り値はメモリオブジェクトへのポインターです。
LMEM_MOVEABLE
0x0002
移動可能なメモリを割り当てます。メモリブロックが物理メモリ内で移動されることはありませんが、既定のヒープ内では移動される可能性があります。

戻り値はメモリオブジェクトへのハンドルです。ハンドルをポインターに変換するには、 LocalLock 関数を使用します。

この値は LMEM_FIXED と組み合わせることはできません。

LMEM_ZEROINIT
0x0040
メモリの内容をゼロで初期化します。
LPTR
0x0040
LMEM_FIXEDLMEM_ZEROINIT を組み合わせます。
NONZEROLHND
LMEM_MOVEABLE と同じです。
NONZEROLPTR
LMEM_FIXED と同じです。

次の値は廃止されていますが、16 ビット版 Windows との互換性のために用意されています。これらは無視されます。

LMEM_DISCARDABLE
LMEM_NOCOMPACT
LMEM_NODISCARD
uBytesUINT_PTRin割り当てるバイト数。このパラメーターがゼロで、uFlags パラメーターに LMEM_MOVEABLE が指定されている場合、関数は破棄済みとしてマークされたメモリオブジェクトへのハンドルを返します。

戻り値の型: HLOCAL

公式ドキュメント

ヒープから指定されたバイト数を割り当てます。(LocalAlloc)

戻り値

関数が成功した場合、戻り値は新しく割り当てられたメモリオブジェクトへのハンドルです。

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

解説(Remarks)

Windows のメモリ管理では、ローカルヒープとグローバルヒープが分かれて提供されることはありません。そのため、LocalAlloc 関数と GlobalAlloc 関数は本質的に同じです。

移動可能メモリ用のフラグ LHNDLMEM_MOVABLENONZEROLHND は不要なオーバーヘッドを生じさせ、安全に使用するにはロックが必要です。ドキュメントで使用が明示的に指定されている場合を除き、これらの使用は避けるべきです。

新しいアプリケーションでは、ドキュメントでローカル関数を使用するよう明示的に指定されている場合を除き、 ヒープ関数 を使用してください。たとえば、一部の Windows 関数は LocalFree で解放しなければならないメモリを割り当てます。

ヒープに要求を満たすだけの十分な空き領域がない場合、 LocalAllocNULL を返します。NULL はエラーを示すために使用されるため、仮想アドレス 0 が割り当てられることはありません。したがって、NULL ポインターの使用を容易に検出できます。

LocalAlloc 関数が成功した場合、少なくとも要求された量のメモリが割り当てられます。割り当てられた量が要求された量より大きい場合、プロセスはその全体を使用できます。実際に割り当てられたバイト数を確認するには、 LocalSize 関数を使用します。

メモリを解放するには、 LocalFree 関数を使用します。LocalAlloc で割り当てたメモリを GlobalFree を使って解放することは安全ではありません。

次のコードは、LocalAllocLocalFree の簡単な使用例を示しています。

#include <windows.h>
#include <stdio.h>
#include <tchar.h>

void _cdecl _tmain()
{
    LPTSTR pszBuf=NULL;

    pszBuf = (LPTSTR)LocalAlloc(
              LPTR,
              MAX_PATH*sizeof(TCHAR));

    // Handle error condition
    if( pszBuf == NULL )
    {
       _tprintf(TEXT("LocalAlloc failed (%d)\n"), GetLastError());
       return;
    }

    //see how much memory was allocated
    _tprintf(TEXT("LocalAlloc allocated %d bytes\n"), LocalSize(pszBuf));

    // Use the memory allocated

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

各言語での呼び出し定義

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

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

LocalAlloc = ctypes.windll.kernel32.LocalAlloc
LocalAlloc.restype = ctypes.c_void_p
LocalAlloc.argtypes = [
    wintypes.DWORD,  # uFlags : LOCAL_ALLOC_FLAGS
    ctypes.c_size_t,  # uBytes : UINT_PTR
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
LocalAlloc = Fiddle::Function.new(
  lib['LocalAlloc'],
  [
    -Fiddle::TYPE_INT,  # uFlags : LOCAL_ALLOC_FLAGS
    Fiddle::TYPE_UINTPTR_T,  # uBytes : UINT_PTR
  ],
  Fiddle::TYPE_VOIDP)
#[link(name = "kernel32")]
extern "system" {
    fn LocalAlloc(
        uFlags: u32,  // LOCAL_ALLOC_FLAGS
        uBytes: usize  // UINT_PTR
    ) -> *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 LocalAlloc(uint uFlags, UIntPtr uBytes);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_LocalAlloc' -Namespace Win32 -PassThru
# $api::LocalAlloc(uFlags, uBytes)
#uselib "KERNEL32.dll"
#func global LocalAlloc "LocalAlloc" sptr, sptr
; LocalAlloc uFlags, uBytes   ; 戻り値は stat
; uFlags : LOCAL_ALLOC_FLAGS -> "sptr"
; uBytes : UINT_PTR -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "KERNEL32.dll"
#cfunc global LocalAlloc "LocalAlloc" int, sptr
; res = LocalAlloc(uFlags, uBytes)
; uFlags : LOCAL_ALLOC_FLAGS -> "int"
; uBytes : UINT_PTR -> "sptr"
; HLOCAL LocalAlloc(LOCAL_ALLOC_FLAGS uFlags, UINT_PTR uBytes)
#uselib "KERNEL32.dll"
#cfunc global LocalAlloc "LocalAlloc" int, intptr
; res = LocalAlloc(uFlags, uBytes)
; uFlags : LOCAL_ALLOC_FLAGS -> "int"
; uBytes : UINT_PTR -> "intptr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procLocalAlloc = kernel32.NewProc("LocalAlloc")
)

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

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

typedef LocalAllocNative = Pointer<Void> Function(Uint32, UintPtr);
typedef LocalAllocDart = Pointer<Void> Function(int, int);
final LocalAlloc = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<LocalAllocNative, LocalAllocDart>('LocalAlloc');
// uFlags : LOCAL_ALLOC_FLAGS -> Uint32
// uBytes : UINT_PTR -> UintPtr
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function LocalAlloc(
  uFlags: DWORD;   // LOCAL_ALLOC_FLAGS
  uBytes: NativeUInt   // UINT_PTR
): THandle; stdcall;
  external 'KERNEL32.dll' name 'LocalAlloc';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "LocalAlloc"
  c_LocalAlloc :: Word32 -> CUIntPtr -> IO (Ptr ())
-- uFlags : LOCAL_ALLOC_FLAGS -> Word32
-- uBytes : UINT_PTR -> CUIntPtr
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let localalloc =
  foreign "LocalAlloc"
    (uint32_t @-> size_t @-> returning (ptr void))
(* uFlags : LOCAL_ALLOC_FLAGS -> uint32_t *)
(* uBytes : UINT_PTR -> size_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)

(cffi:defcfun ("LocalAlloc" local-alloc :convention :stdcall) :pointer
  (u-flags :uint32)   ; LOCAL_ALLOC_FLAGS
  (u-bytes :uint64))   ; UINT_PTR
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $LocalAlloc = Win32::API::More->new('KERNEL32',
    'HANDLE LocalAlloc(DWORD uFlags, WPARAM uBytes)');
# my $ret = $LocalAlloc->Call($uFlags, $uBytes);
# uFlags : LOCAL_ALLOC_FLAGS -> DWORD
# uBytes : UINT_PTR -> WPARAM
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目
使用する型