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

CheckMenuItem

関数
メニュー項目のチェック状態を設定する。
DLLUSER32.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

DWORD CheckMenuItem(
    HMENU hMenu,
    DWORD uIDCheckItem,
    DWORD uCheck
);

パラメーター

名前方向説明
hMenuHMENUin対象のメニューへのハンドル。
uIDCheckItemDWORDinチェックマーク属性を設定するメニュー項目。uCheck パラメーターによって解釈が決まります。
uCheckDWORDin

uIDCheckItem パラメーターの解釈と、メニュー項目のチェックマーク属性の状態を制御するフラグ。このパラメーターには、MF_BYCOMMAND または MF_BYPOSITION のいずれかと、MF_CHECKED または MF_UNCHECKED を組み合わせて指定できます。

意味
MF_BYCOMMAND
0x00000000L
uIDCheckItem パラメーターがメニュー項目の識別子を指定することを示します。MF_BYCOMMAND フラグは既定値であり、MF_BYCOMMANDMF_BYPOSITION のいずれも指定されていない場合に適用されます。
MF_BYPOSITION
0x00000400L
uIDCheckItem パラメーターがメニュー項目の 0 から始まる相対位置を指定することを示します。
MF_CHECKED
0x00000008L
チェックマーク属性を選択状態に設定します。
MF_UNCHECKED
0x00000000L
チェックマーク属性をクリア状態に設定します。

戻り値の型: DWORD

公式ドキュメント

指定したメニュー項目のチェックマーク属性の状態を、選択状態またはクリア状態のいずれかに設定します。

戻り値

型: DWORD

戻り値はメニュー項目の以前の状態(MF_CHECKED または MF_UNCHECKED)を表します。メニュー項目が存在しない場合、戻り値は UINT_MAX になります。

解説(Remarks)

メニューバー内の項目にはチェックマークを付けることができません。

uIDCheckItem パラメーターは、サブメニューを開く項目またはコマンド項目を識別します。サブメニューを開く項目の場合、uIDCheckItem パラメーターには項目の位置を指定する必要があります。コマンド項目の場合、uIDCheckItem パラメーターには項目の位置または識別子のいずれかを指定できます。

例については、メニューでのチェックボックスのシミュレートを参照してください。

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

各言語での呼び出し定義

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

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

CheckMenuItem = ctypes.windll.user32.CheckMenuItem
CheckMenuItem.restype = wintypes.DWORD
CheckMenuItem.argtypes = [
    wintypes.HANDLE,  # hMenu : HMENU
    wintypes.DWORD,  # uIDCheckItem : DWORD
    wintypes.DWORD,  # uCheck : DWORD
]
require 'fiddle'
require 'fiddle/import'

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

var (
	user32 = windows.NewLazySystemDLL("USER32.dll")
	procCheckMenuItem = user32.NewProc("CheckMenuItem")
)

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

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

typedef CheckMenuItemNative = Uint32 Function(Pointer<Void>, Uint32, Uint32);
typedef CheckMenuItemDart = int Function(Pointer<Void>, int, int);
final CheckMenuItem = DynamicLibrary.open('USER32.dll')
    .lookupFunction<CheckMenuItemNative, CheckMenuItemDart>('CheckMenuItem');
// hMenu : HMENU -> Pointer<Void>
// uIDCheckItem : DWORD -> Uint32
// uCheck : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function CheckMenuItem(
  hMenu: THandle;   // HMENU
  uIDCheckItem: DWORD;   // DWORD
  uCheck: DWORD   // DWORD
): DWORD; stdcall;
  external 'USER32.dll' name 'CheckMenuItem';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "CheckMenuItem"
  c_CheckMenuItem :: Ptr () -> Word32 -> Word32 -> IO Word32
-- hMenu : HMENU -> Ptr ()
-- uIDCheckItem : DWORD -> Word32
-- uCheck : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let checkmenuitem =
  foreign "CheckMenuItem"
    ((ptr void) @-> uint32_t @-> uint32_t @-> returning uint32_t)
(* hMenu : HMENU -> (ptr void) *)
(* uIDCheckItem : DWORD -> uint32_t *)
(* uCheck : DWORD -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library user32 (t "USER32.dll"))
(cffi:use-foreign-library user32)

(cffi:defcfun ("CheckMenuItem" check-menu-item :convention :stdcall) :uint32
  (h-menu :pointer)   ; HMENU
  (u-idcheck-item :uint32)   ; DWORD
  (u-check :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $CheckMenuItem = Win32::API::More->new('USER32',
    'DWORD CheckMenuItem(HANDLE hMenu, DWORD uIDCheckItem, DWORD uCheck)');
# my $ret = $CheckMenuItem->Call($hMenu, $uIDCheckItem, $uCheck);
# hMenu : HMENU -> HANDLE
# uIDCheckItem : DWORD -> DWORD
# uCheck : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目