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

GlobalAlloc

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

シグネチャ

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

HGLOBAL GlobalAlloc(
    GLOBAL_ALLOC_FLAGS uFlags,
    UINT_PTR dwBytes
);

パラメーター

名前方向説明
uFlagsGLOBAL_ALLOC_FLAGSin

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

意味
GHND
0x0042
GMEM_MOVEABLEGMEM_ZEROINIT を組み合わせます。
GMEM_FIXED
0x0000
固定メモリを割り当てます。戻り値はポインターです。
GMEM_MOVEABLE
0x0002
移動可能なメモリを割り当てます。メモリ ブロックが物理メモリ内で移動することはありませんが、既定のヒープ内では移動できます。

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

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

GMEM_ZEROINIT
0x0040
メモリの内容をゼロで初期化します。
GPTR
0x0040
GMEM_FIXEDGMEM_ZEROINIT を組み合わせます。

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

GMEM_DDESHARE
GMEM_DISCARDABLE
GMEM_LOWER
GMEM_NOCOMPACT
GMEM_NODISCARD
GMEM_NOT_BANKED
GMEM_NOTIFY
GMEM_SHARE
dwBytesUINT_PTRin割り当てるバイト数。このパラメーターがゼロで、かつ uFlags パラメーターに GMEM_MOVEABLE を指定した場合、関数は破棄済みとしてマークされたメモリ オブジェクトへのハンドルを返します。

戻り値の型: HGLOBAL

公式ドキュメント

ヒープから指定したバイト数のメモリを割り当てます。(GlobalAlloc)

戻り値

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

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

解説(Remarks)

Windows のメモリ管理では、ローカル ヒープとグローバル ヒープを別々に提供していません。そのため、GlobalAlloc 関数と LocalAlloc 関数は本質的に同じものです。

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

新しいアプリケーションでは、グローバル関数を使用すべきとドキュメントに明示的に記載されている場合を除き、 ヒープ関数 を使用してメモリを割り当てて管理してください。たとえば、グローバル関数は、現在もダイナミック データ エクスチェンジ (DDE)、クリップボード関数、および OLE データ オブジェクトで使用されています。

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

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

この関数で割り当てられたメモリは、8 バイト境界に整列していることが保証されます。動的に生成されたコードを実行するには、VirtualAlloc 関数を使用してメモリを割り当て、VirtualProtect 関数を使用して PAGE_EXECUTE アクセスを許可してください。

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

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

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

void _cdecl main()
{
    PSECURITY_DESCRIPTOR pSD;

    pSD = (PSECURITY_DESCRIPTOR) GlobalAlloc(
           GMEM_FIXED,
           sizeof(PSECURITY_DESCRIPTOR));

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

    //see how much memory was allocated
    _tprintf(TEXT("GlobalAlloc allocated %d bytes\n"), GlobalSize(pSD));

    // Use the memory allocated

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

各言語での呼び出し定義

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

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

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

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

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procGlobalAlloc = kernel32.NewProc("GlobalAlloc")
)

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

extern "kernel32" fn GlobalAlloc(
    uFlags: u32, // GLOBAL_ALLOC_FLAGS
    dwBytes: usize // UINT_PTR
) callconv(std.os.windows.WINAPI) ?*anyopaque;
proc GlobalAlloc(
    uFlags: uint32,  # GLOBAL_ALLOC_FLAGS
    dwBytes: uint  # UINT_PTR
): pointer {.importc: "GlobalAlloc", stdcall, dynlib: "KERNEL32.dll".}
pragma(lib, "kernel32");
extern(Windows)
void* GlobalAlloc(
    uint uFlags,   // GLOBAL_ALLOC_FLAGS
    size_t dwBytes   // UINT_PTR
);
ccall((:GlobalAlloc, "KERNEL32.dll"), stdcall, Ptr{Cvoid},
      (UInt32, Csize_t),
      uFlags, dwBytes)
# uFlags : GLOBAL_ALLOC_FLAGS -> UInt32
# dwBytes : UINT_PTR -> Csize_t
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
void* GlobalAlloc(
    uint32_t uFlags,
    uintptr_t dwBytes);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.GlobalAlloc(uFlags, dwBytes)
-- uFlags : GLOBAL_ALLOC_FLAGS
-- dwBytes : UINT_PTR
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const GlobalAlloc = lib.func('__stdcall', 'GlobalAlloc', 'void *', ['uint32_t', 'uintptr_t']);
// GlobalAlloc(uFlags, dwBytes)
// uFlags : GLOBAL_ALLOC_FLAGS -> 'uint32_t'
// dwBytes : UINT_PTR -> 'uintptr_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("KERNEL32.dll", {
  GlobalAlloc: { parameters: ["u32", "usize"], result: "pointer" },
});
// lib.symbols.GlobalAlloc(uFlags, dwBytes)
// uFlags : GLOBAL_ALLOC_FLAGS -> "u32"
// dwBytes : UINT_PTR -> "usize"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
void* GlobalAlloc(
    uint32_t uFlags,
    size_t dwBytes);
C, "KERNEL32.dll");
// $ffi->GlobalAlloc(uFlags, dwBytes);
// uFlags : GLOBAL_ALLOC_FLAGS
// dwBytes : 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 GlobalAlloc(
        int uFlags,   // GLOBAL_ALLOC_FLAGS
        long dwBytes   // UINT_PTR
    );
}
@[Link("kernel32")]
lib LibKERNEL32
  fun GlobalAlloc = GlobalAlloc(
    uFlags : UInt32,   # GLOBAL_ALLOC_FLAGS
    dwBytes : 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 GlobalAllocNative = Pointer<Void> Function(Uint32, UintPtr);
typedef GlobalAllocDart = Pointer<Void> Function(int, int);
final GlobalAlloc = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<GlobalAllocNative, GlobalAllocDart>('GlobalAlloc');
// uFlags : GLOBAL_ALLOC_FLAGS -> Uint32
// dwBytes : UINT_PTR -> UintPtr
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function GlobalAlloc(
  uFlags: DWORD;   // GLOBAL_ALLOC_FLAGS
  dwBytes: NativeUInt   // UINT_PTR
): THandle; stdcall;
  external 'KERNEL32.dll' name 'GlobalAlloc';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

let globalalloc =
  foreign "GlobalAlloc"
    (uint32_t @-> size_t @-> returning (ptr void))
(* uFlags : GLOBAL_ALLOC_FLAGS -> uint32_t *)
(* dwBytes : 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 ("GlobalAlloc" global-alloc :convention :stdcall) :pointer
  (u-flags :uint32)   ; GLOBAL_ALLOC_FLAGS
  (dw-bytes :uint64))   ; UINT_PTR
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $GlobalAlloc = Win32::API::More->new('KERNEL32',
    'HANDLE GlobalAlloc(DWORD uFlags, WPARAM dwBytes)');
# my $ret = $GlobalAlloc->Call($uFlags, $dwBytes);
# uFlags : GLOBAL_ALLOC_FLAGS -> DWORD
# dwBytes : UINT_PTR -> WPARAM
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

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