Win32 API 日本語リファレンス
ホームUI.WindowsAndMessaging › SetMenuItemBitmaps

SetMenuItemBitmaps

関数
メニュー項目に表示するチェック用ビットマップを設定する。
DLLUSER32.dll呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

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

BOOL SetMenuItemBitmaps(
    HMENU hMenu,
    DWORD uPosition,
    MENU_ITEM_FLAGS uFlags,
    HBITMAP hBitmapUnchecked,   // optional
    HBITMAP hBitmapChecked   // optional
);

パラメーター

名前方向説明
hMenuHMENUin新しいチェックマーク用ビットマップを設定する項目を含むメニューへのハンドル。
uPositionDWORDin変更するメニュー項目。uFlags パラメーターによって解釈方法が決まります。
uFlagsMENU_ITEM_FLAGSin

uPosition パラメーターの解釈方法を指定します。uFlags パラメーターは次のいずれかの値でなければなりません。

意味
MF_BYCOMMAND
0x00000000L
uPosition がメニュー項目の識別子を指定することを示します。MF_BYCOMMANDMF_BYPOSITION のどちらも指定しない場合は、既定で MF_BYCOMMAND が適用されます。
MF_BYPOSITION
0x00000400L
uPosition がメニュー項目の 0 から始まる相対位置を指定することを示します。
hBitmapUncheckedHBITMAPinoptionalメニュー項目が選択されていないときに表示されるビットマップへのハンドル。
hBitmapCheckedHBITMAPinoptionalメニュー項目が選択されているときに表示されるビットマップへのハンドル。

戻り値の型: BOOL

公式ドキュメント

指定したビットマップをメニュー項目に関連付けます。メニュー項目が選択されているかどうかに応じて、システムはメニュー項目の横に適切なビットマップを表示します。

戻り値

型: BOOL

関数が成功した場合、戻り値は 0 以外の値です。

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

解説(Remarks)

hBitmapUnchecked または hBitmapChecked パラメーターのいずれかが NULL の場合、システムは対応するチェック状態についてメニュー項目の横に何も表示しません。両方のパラメーターが NULL の場合、システムは項目が選択されているときに既定のチェックマーク用ビットマップを表示し、項目が選択されていないときはビットマップを削除します。

メニューが破棄されても、これらのビットマップは破棄されません。ビットマップの破棄はアプリケーションの責任です。

選択時およびクリア時のビットマップはモノクロにする必要があります。システムは論理 AND 演算子を使用してビットマップをメニューと合成するため、白い部分は透明になり、黒い部分はメニュー項目の色になります。カラービットマップを使用すると、望ましくない結果になる場合があります。

ビットマップの寸法を取得するには、GetSystemMetrics 関数に SM_CXMENUCHECK および SM_CYMENUCHECK 値を指定して使用します。

例については、Simulating Check Boxes in a Menu を参照してください。

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

各言語での呼び出し定義

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

BOOL SetMenuItemBitmaps(
    HMENU hMenu,
    DWORD uPosition,
    MENU_ITEM_FLAGS uFlags,
    HBITMAP hBitmapUnchecked,   // optional
    HBITMAP hBitmapChecked   // optional
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("USER32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool SetMenuItemBitmaps(
    IntPtr hMenu,   // HMENU
    uint uPosition,   // DWORD
    uint uFlags,   // MENU_ITEM_FLAGS
    IntPtr hBitmapUnchecked,   // HBITMAP optional
    IntPtr hBitmapChecked   // HBITMAP optional
);
<DllImport("USER32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function SetMenuItemBitmaps(
    hMenu As IntPtr,   ' HMENU
    uPosition As UInteger,   ' DWORD
    uFlags As UInteger,   ' MENU_ITEM_FLAGS
    hBitmapUnchecked As IntPtr,   ' HBITMAP optional
    hBitmapChecked As IntPtr   ' HBITMAP optional
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' hMenu : HMENU
' uPosition : DWORD
' uFlags : MENU_ITEM_FLAGS
' hBitmapUnchecked : HBITMAP optional
' hBitmapChecked : HBITMAP optional
Declare PtrSafe Function SetMenuItemBitmaps Lib "user32" ( _
    ByVal hMenu As LongPtr, _
    ByVal uPosition As Long, _
    ByVal uFlags As Long, _
    ByVal hBitmapUnchecked As LongPtr, _
    ByVal hBitmapChecked As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

SetMenuItemBitmaps = ctypes.windll.user32.SetMenuItemBitmaps
SetMenuItemBitmaps.restype = wintypes.BOOL
SetMenuItemBitmaps.argtypes = [
    wintypes.HANDLE,  # hMenu : HMENU
    wintypes.DWORD,  # uPosition : DWORD
    wintypes.DWORD,  # uFlags : MENU_ITEM_FLAGS
    wintypes.HANDLE,  # hBitmapUnchecked : HBITMAP optional
    wintypes.HANDLE,  # hBitmapChecked : HBITMAP optional
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('USER32.dll')
SetMenuItemBitmaps = Fiddle::Function.new(
  lib['SetMenuItemBitmaps'],
  [
    Fiddle::TYPE_VOIDP,  # hMenu : HMENU
    -Fiddle::TYPE_INT,  # uPosition : DWORD
    -Fiddle::TYPE_INT,  # uFlags : MENU_ITEM_FLAGS
    Fiddle::TYPE_VOIDP,  # hBitmapUnchecked : HBITMAP optional
    Fiddle::TYPE_VOIDP,  # hBitmapChecked : HBITMAP optional
  ],
  Fiddle::TYPE_INT)
#[link(name = "user32")]
extern "system" {
    fn SetMenuItemBitmaps(
        hMenu: *mut core::ffi::c_void,  // HMENU
        uPosition: u32,  // DWORD
        uFlags: u32,  // MENU_ITEM_FLAGS
        hBitmapUnchecked: *mut core::ffi::c_void,  // HBITMAP optional
        hBitmapChecked: *mut core::ffi::c_void  // HBITMAP optional
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("USER32.dll", SetLastError = true)]
public static extern bool SetMenuItemBitmaps(IntPtr hMenu, uint uPosition, uint uFlags, IntPtr hBitmapUnchecked, IntPtr hBitmapChecked);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_SetMenuItemBitmaps' -Namespace Win32 -PassThru
# $api::SetMenuItemBitmaps(hMenu, uPosition, uFlags, hBitmapUnchecked, hBitmapChecked)
#uselib "USER32.dll"
#func global SetMenuItemBitmaps "SetMenuItemBitmaps" sptr, sptr, sptr, sptr, sptr
; SetMenuItemBitmaps hMenu, uPosition, uFlags, hBitmapUnchecked, hBitmapChecked   ; 戻り値は stat
; hMenu : HMENU -> "sptr"
; uPosition : DWORD -> "sptr"
; uFlags : MENU_ITEM_FLAGS -> "sptr"
; hBitmapUnchecked : HBITMAP optional -> "sptr"
; hBitmapChecked : HBITMAP optional -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "USER32.dll"
#cfunc global SetMenuItemBitmaps "SetMenuItemBitmaps" sptr, int, int, sptr, sptr
; res = SetMenuItemBitmaps(hMenu, uPosition, uFlags, hBitmapUnchecked, hBitmapChecked)
; hMenu : HMENU -> "sptr"
; uPosition : DWORD -> "int"
; uFlags : MENU_ITEM_FLAGS -> "int"
; hBitmapUnchecked : HBITMAP optional -> "sptr"
; hBitmapChecked : HBITMAP optional -> "sptr"
; BOOL SetMenuItemBitmaps(HMENU hMenu, DWORD uPosition, MENU_ITEM_FLAGS uFlags, HBITMAP hBitmapUnchecked, HBITMAP hBitmapChecked)
#uselib "USER32.dll"
#cfunc global SetMenuItemBitmaps "SetMenuItemBitmaps" intptr, int, int, intptr, intptr
; res = SetMenuItemBitmaps(hMenu, uPosition, uFlags, hBitmapUnchecked, hBitmapChecked)
; hMenu : HMENU -> "intptr"
; uPosition : DWORD -> "int"
; uFlags : MENU_ITEM_FLAGS -> "int"
; hBitmapUnchecked : HBITMAP optional -> "intptr"
; hBitmapChecked : HBITMAP optional -> "intptr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	user32 = windows.NewLazySystemDLL("USER32.dll")
	procSetMenuItemBitmaps = user32.NewProc("SetMenuItemBitmaps")
)

// hMenu (HMENU), uPosition (DWORD), uFlags (MENU_ITEM_FLAGS), hBitmapUnchecked (HBITMAP optional), hBitmapChecked (HBITMAP optional)
r1, _, err := procSetMenuItemBitmaps.Call(
	uintptr(hMenu),
	uintptr(uPosition),
	uintptr(uFlags),
	uintptr(hBitmapUnchecked),
	uintptr(hBitmapChecked),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function SetMenuItemBitmaps(
  hMenu: THandle;   // HMENU
  uPosition: DWORD;   // DWORD
  uFlags: DWORD;   // MENU_ITEM_FLAGS
  hBitmapUnchecked: THandle;   // HBITMAP optional
  hBitmapChecked: THandle   // HBITMAP optional
): BOOL; stdcall;
  external 'USER32.dll' name 'SetMenuItemBitmaps';
result := DllCall("USER32\SetMenuItemBitmaps"
    , "Ptr", hMenu   ; HMENU
    , "UInt", uPosition   ; DWORD
    , "UInt", uFlags   ; MENU_ITEM_FLAGS
    , "Ptr", hBitmapUnchecked   ; HBITMAP optional
    , "Ptr", hBitmapChecked   ; HBITMAP optional
    , "Int")   ; return: BOOL
●SetMenuItemBitmaps(hMenu, uPosition, uFlags, hBitmapUnchecked, hBitmapChecked) = DLL("USER32.dll", "bool SetMenuItemBitmaps(void*, dword, dword, void*, void*)")
# 呼び出し: SetMenuItemBitmaps(hMenu, uPosition, uFlags, hBitmapUnchecked, hBitmapChecked)
# hMenu : HMENU -> "void*"
# uPosition : DWORD -> "dword"
# uFlags : MENU_ITEM_FLAGS -> "dword"
# hBitmapUnchecked : HBITMAP optional -> "void*"
# hBitmapChecked : HBITMAP optional -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

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

typedef SetMenuItemBitmapsNative = Int32 Function(Pointer<Void>, Uint32, Uint32, Pointer<Void>, Pointer<Void>);
typedef SetMenuItemBitmapsDart = int Function(Pointer<Void>, int, int, Pointer<Void>, Pointer<Void>);
final SetMenuItemBitmaps = DynamicLibrary.open('USER32.dll')
    .lookupFunction<SetMenuItemBitmapsNative, SetMenuItemBitmapsDart>('SetMenuItemBitmaps');
// hMenu : HMENU -> Pointer<Void>
// uPosition : DWORD -> Uint32
// uFlags : MENU_ITEM_FLAGS -> Uint32
// hBitmapUnchecked : HBITMAP optional -> Pointer<Void>
// hBitmapChecked : HBITMAP optional -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SetMenuItemBitmaps(
  hMenu: THandle;   // HMENU
  uPosition: DWORD;   // DWORD
  uFlags: DWORD;   // MENU_ITEM_FLAGS
  hBitmapUnchecked: THandle;   // HBITMAP optional
  hBitmapChecked: THandle   // HBITMAP optional
): BOOL; stdcall;
  external 'USER32.dll' name 'SetMenuItemBitmaps';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SetMenuItemBitmaps"
  c_SetMenuItemBitmaps :: Ptr () -> Word32 -> Word32 -> Ptr () -> Ptr () -> IO CInt
-- hMenu : HMENU -> Ptr ()
-- uPosition : DWORD -> Word32
-- uFlags : MENU_ITEM_FLAGS -> Word32
-- hBitmapUnchecked : HBITMAP optional -> Ptr ()
-- hBitmapChecked : HBITMAP optional -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let setmenuitembitmaps =
  foreign "SetMenuItemBitmaps"
    ((ptr void) @-> uint32_t @-> uint32_t @-> (ptr void) @-> (ptr void) @-> returning int32_t)
(* hMenu : HMENU -> (ptr void) *)
(* uPosition : DWORD -> uint32_t *)
(* uFlags : MENU_ITEM_FLAGS -> uint32_t *)
(* hBitmapUnchecked : HBITMAP optional -> (ptr void) *)
(* hBitmapChecked : HBITMAP optional -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library user32 (t "USER32.dll"))
(cffi:use-foreign-library user32)

(cffi:defcfun ("SetMenuItemBitmaps" set-menu-item-bitmaps :convention :stdcall) :int32
  (h-menu :pointer)   ; HMENU
  (u-position :uint32)   ; DWORD
  (u-flags :uint32)   ; MENU_ITEM_FLAGS
  (h-bitmap-unchecked :pointer)   ; HBITMAP optional
  (h-bitmap-checked :pointer))   ; HBITMAP optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SetMenuItemBitmaps = Win32::API::More->new('USER32',
    'BOOL SetMenuItemBitmaps(HANDLE hMenu, DWORD uPosition, DWORD uFlags, HANDLE hBitmapUnchecked, HANDLE hBitmapChecked)');
# my $ret = $SetMenuItemBitmaps->Call($hMenu, $uPosition, $uFlags, $hBitmapUnchecked, $hBitmapChecked);
# hMenu : HMENU -> HANDLE
# uPosition : DWORD -> DWORD
# uFlags : MENU_ITEM_FLAGS -> DWORD
# hBitmapUnchecked : HBITMAP optional -> HANDLE
# hBitmapChecked : HBITMAP optional -> HANDLE
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型