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

LocalSize

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

シグネチャ

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

UINT_PTR LocalSize(
    HLOCAL hMem
);

パラメーター

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

戻り値の型: UINT_PTR

公式ドキュメント

指定されたローカルメモリオブジェクトの現在のサイズを、バイト単位で取得します。

戻り値

関数が成功した場合、戻り値は指定されたローカルメモリオブジェクトのサイズ(バイト単位)です。指定されたハンドルが無効な場合、またはオブジェクトが破棄されている場合、戻り値は 0 になります。拡張エラー情報を取得するには、 GetLastError を呼び出してください。

解説(Remarks)

メモリブロックのサイズは、メモリの割り当て時に要求されたサイズよりも大きくなる場合があります。

指定されたオブジェクトのメモリブロックが破棄されていないことを確認するには、LocalSize を呼び出す前に LocalFlags 関数を呼び出してください。

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

各言語での呼び出し定義

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

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

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

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procLocalSize = kernel32.NewProc("LocalSize")
)

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

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

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

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

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

関連項目

公式の関連項目