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

LocalFlags

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

シグネチャ

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

DWORD LocalFlags(
    HLOCAL hMem
);

パラメーター

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

戻り値の型: DWORD

公式ドキュメント

指定したローカルメモリオブジェクトに関する情報を取得します。

戻り値

関数が成功した場合、戻り値はメモリオブジェクトのアロケーション値とロックカウントを示します。

関数が失敗した場合、戻り値は LMEM_INVALID_HANDLE となり、ローカルハンドルが無効であることを示します。拡張エラー情報を取得するには、 GetLastError を呼び出します。

解説(Remarks)

戻り値の下位ワードの下位バイトには、オブジェクトのロックカウントが格納されます。戻り値からロックカウントを取得するには、LMEM_LOCKCOUNT マスクとビットごとの AND (&) 演算子を使用します。LMEM_FIXED で割り当てられたメモリオブジェクトのロックカウントは常にゼロです。

戻り値の下位ワードの上位バイトは、メモリオブジェクトのアロケーション値を示します。これはゼロまたは LMEM_DISCARDABLE のいずれかになります。

ローカル関数は他のメモリ管理関数に比べてオーバーヘッドが大きく、機能も少なくなっています。新しいアプリケーションでは、ローカル関数を使用するようドキュメントで指定されている場合を除き、ヒープ関数を使用してください。詳細については、Global and Local Functions を参照してください。

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

各言語での呼び出し定義

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

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

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

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procLocalFlags = kernel32.NewProc("LocalFlags")
)

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

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

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

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

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

関連項目

公式の関連項目