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

HiliteMenuItem

関数
メニューバー項目の強調表示状態を切り替える。
DLLUSER32.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

BOOL HiliteMenuItem(
    HWND hWnd,
    HMENU hMenu,
    DWORD uIDHiliteItem,
    DWORD uHilite
);

パラメーター

名前方向説明
hWndHWNDinメニューを含むウィンドウへのハンドルです。
hMenuHMENUin項目を含むメニューバーへのハンドルです。
uIDHiliteItemDWORDinメニュー項目です。このパラメーターは、uHilite パラメーターの値に応じて、メニュー項目の識別子、またはメニューバー内でのメニュー項目のオフセットのいずれかになります。
uHiliteDWORDin

uItemHilite パラメーターの解釈方法を制御し、メニュー項目を強調表示するかどうかを指定します。このパラメーターには、MF_BYCOMMAND または MF_BYPOSITION のいずれかと、MF_HILITE または MF_UNHILITE のいずれかを組み合わせて指定する必要があります。

意味
MF_BYCOMMAND
0x00000000L
uItemHilite がメニュー項目の識別子を示すことを表します。
MF_BYPOSITION
0x00000400L
uItemHilite がメニュー項目の 0 から始まる相対位置を示すことを表します。
MF_HILITE
0x00000080L
メニュー項目を強調表示します。このフラグを指定しない場合、項目の強調表示が解除されます。
MF_UNHILITE
0x00000000L
メニュー項目の強調表示を解除します。

戻り値の型: BOOL

公式ドキュメント

メニューバー内の項目に強調表示を追加、または強調表示を解除します。

戻り値

型: BOOL

メニュー項目が指定した強調表示状態に設定された場合、戻り値は 0 以外になります。

メニュー項目が指定した強調表示状態に設定されなかった場合、戻り値は 0 になります。

解説(Remarks)

MF_HILITE および MF_UNHILITE フラグは HiliteMenuItem 関数でのみ使用できます。これらを ModifyMenu 関数で使用することはできません。

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

各言語での呼び出し定義

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

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

HiliteMenuItem = ctypes.windll.user32.HiliteMenuItem
HiliteMenuItem.restype = wintypes.BOOL
HiliteMenuItem.argtypes = [
    wintypes.HANDLE,  # hWnd : HWND
    wintypes.HANDLE,  # hMenu : HMENU
    wintypes.DWORD,  # uIDHiliteItem : DWORD
    wintypes.DWORD,  # uHilite : DWORD
]
require 'fiddle'
require 'fiddle/import'

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

var (
	user32 = windows.NewLazySystemDLL("USER32.dll")
	procHiliteMenuItem = user32.NewProc("HiliteMenuItem")
)

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

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

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

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

let hilitemenuitem =
  foreign "HiliteMenuItem"
    ((ptr void) @-> (ptr void) @-> uint32_t @-> uint32_t @-> returning int32_t)
(* hWnd : HWND -> (ptr void) *)
(* hMenu : HMENU -> (ptr void) *)
(* uIDHiliteItem : DWORD -> uint32_t *)
(* uHilite : 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 ("HiliteMenuItem" hilite-menu-item :convention :stdcall) :int32
  (h-wnd :pointer)   ; HWND
  (h-menu :pointer)   ; HMENU
  (u-idhilite-item :uint32)   ; DWORD
  (u-hilite :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $HiliteMenuItem = Win32::API::More->new('USER32',
    'BOOL HiliteMenuItem(HANDLE hWnd, HANDLE hMenu, DWORD uIDHiliteItem, DWORD uHilite)');
# my $ret = $HiliteMenuItem->Call($hWnd, $hMenu, $uIDHiliteItem, $uHilite);
# hWnd : HWND -> HANDLE
# hMenu : HMENU -> HANDLE
# uIDHiliteItem : DWORD -> DWORD
# uHilite : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目