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

MenuHelp

関数
メニュー選択に応じたヘルプ文字列をステータスバーに表示する。
DLLCOMCTL32.dll呼出規約winapi対応OSWindows Vista 以降

シグネチャ

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

void MenuHelp(
    DWORD uMsg,
    WPARAM wParam,
    LPARAM lParam,
    HMENU hMainMenu,
    HINSTANCE hInst,
    HWND hwndStatus,
    DWORD* lpwIDs
);

パラメーター

名前方向説明
uMsgDWORDin処理対象のメッセージ。WM_MENUSELECT または WM_COMMAND のいずれかを指定できます。
wParamWPARAMin
                <i>uMsg</i> で指定したメッセージの wParam。
lParamLPARAMin
                <i>uMsg</i> で指定したメッセージの lParam。
hMainMenuHMENUinアプリケーションのメインメニューへのハンドル。
hInstHINSTANCEin文字列リソースを格納しているモジュールへのハンドル。
hwndStatusHWNDinステータスウィンドウへのハンドル。
lpwIDsDWORD*in文字列リソース識別子とメニューハンドルのペアを格納した値の配列へのポインター。この関数は配列内で選択されたメニューのハンドルを検索し、見つかった場合は対応するリソース識別子を使用して適切なヘルプ文字列を読み込みます。

戻り値の型: void

公式ドキュメント

WM_MENUSELECT メッセージおよび WM_COMMAND メッセージを処理し、現在のメニューに関するヘルプテキストを指定されたステータスウィンドウに表示します。

解説(Remarks)

MenuHelp 関数はヘルパー関数です。ヘルパー関数はプログラミングの便宜のために用意されています。これらは頻繁に使用される一連の呼び出しを 1 回の呼び出しにまとめたものです。MenuHelp は、WM_MENUSELECT メッセージおよび WM_COMMAND メッセージを送信するために使用します。

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

各言語での呼び出し定義

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

void MenuHelp(
    DWORD uMsg,
    WPARAM wParam,
    LPARAM lParam,
    HMENU hMainMenu,
    HINSTANCE hInst,
    HWND hwndStatus,
    DWORD* lpwIDs
);
[DllImport("COMCTL32.dll", ExactSpelling = true)]
static extern void MenuHelp(
    uint uMsg,   // DWORD
    UIntPtr wParam,   // WPARAM
    IntPtr lParam,   // LPARAM
    IntPtr hMainMenu,   // HMENU
    IntPtr hInst,   // HINSTANCE
    IntPtr hwndStatus,   // HWND
    ref uint lpwIDs   // DWORD*
);
<DllImport("COMCTL32.dll", ExactSpelling:=True)>
Public Shared Sub MenuHelp(
    uMsg As UInteger,   ' DWORD
    wParam As UIntPtr,   ' WPARAM
    lParam As IntPtr,   ' LPARAM
    hMainMenu As IntPtr,   ' HMENU
    hInst As IntPtr,   ' HINSTANCE
    hwndStatus As IntPtr,   ' HWND
    ByRef lpwIDs As UInteger   ' DWORD*
)
End Sub
' uMsg : DWORD
' wParam : WPARAM
' lParam : LPARAM
' hMainMenu : HMENU
' hInst : HINSTANCE
' hwndStatus : HWND
' lpwIDs : DWORD*
Declare PtrSafe Sub MenuHelp Lib "comctl32" ( _
    ByVal uMsg As Long, _
    ByVal wParam As LongPtr, _
    ByVal lParam As LongPtr, _
    ByVal hMainMenu As LongPtr, _
    ByVal hInst As LongPtr, _
    ByVal hwndStatus As LongPtr, _
    ByRef lpwIDs As Long)
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

MenuHelp = ctypes.windll.comctl32.MenuHelp
MenuHelp.restype = None
MenuHelp.argtypes = [
    wintypes.DWORD,  # uMsg : DWORD
    ctypes.c_size_t,  # wParam : WPARAM
    ctypes.c_ssize_t,  # lParam : LPARAM
    wintypes.HANDLE,  # hMainMenu : HMENU
    wintypes.HANDLE,  # hInst : HINSTANCE
    wintypes.HANDLE,  # hwndStatus : HWND
    ctypes.POINTER(wintypes.DWORD),  # lpwIDs : DWORD*
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('COMCTL32.dll')
MenuHelp = Fiddle::Function.new(
  lib['MenuHelp'],
  [
    -Fiddle::TYPE_INT,  # uMsg : DWORD
    Fiddle::TYPE_UINTPTR_T,  # wParam : WPARAM
    Fiddle::TYPE_INTPTR_T,  # lParam : LPARAM
    Fiddle::TYPE_VOIDP,  # hMainMenu : HMENU
    Fiddle::TYPE_VOIDP,  # hInst : HINSTANCE
    Fiddle::TYPE_VOIDP,  # hwndStatus : HWND
    Fiddle::TYPE_VOIDP,  # lpwIDs : DWORD*
  ],
  Fiddle::TYPE_VOID)
#[link(name = "comctl32")]
extern "system" {
    fn MenuHelp(
        uMsg: u32,  // DWORD
        wParam: usize,  // WPARAM
        lParam: isize,  // LPARAM
        hMainMenu: *mut core::ffi::c_void,  // HMENU
        hInst: *mut core::ffi::c_void,  // HINSTANCE
        hwndStatus: *mut core::ffi::c_void,  // HWND
        lpwIDs: *mut u32  // DWORD*
    );
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("COMCTL32.dll")]
public static extern void MenuHelp(uint uMsg, UIntPtr wParam, IntPtr lParam, IntPtr hMainMenu, IntPtr hInst, IntPtr hwndStatus, ref uint lpwIDs);
"@
$api = Add-Type -MemberDefinition $sig -Name 'COMCTL32_MenuHelp' -Namespace Win32 -PassThru
# $api::MenuHelp(uMsg, wParam, lParam, hMainMenu, hInst, hwndStatus, lpwIDs)
#uselib "COMCTL32.dll"
#func global MenuHelp "MenuHelp" sptr, sptr, sptr, sptr, sptr, sptr, sptr
; MenuHelp uMsg, wParam, lParam, hMainMenu, hInst, hwndStatus, varptr(lpwIDs)
; uMsg : DWORD -> "sptr"
; wParam : WPARAM -> "sptr"
; lParam : LPARAM -> "sptr"
; hMainMenu : HMENU -> "sptr"
; hInst : HINSTANCE -> "sptr"
; hwndStatus : HWND -> "sptr"
; lpwIDs : DWORD* -> "sptr"
出力引数:
#uselib "COMCTL32.dll"
#func global MenuHelp "MenuHelp" int, sptr, sptr, sptr, sptr, sptr, var
; MenuHelp uMsg, wParam, lParam, hMainMenu, hInst, hwndStatus, lpwIDs
; uMsg : DWORD -> "int"
; wParam : WPARAM -> "sptr"
; lParam : LPARAM -> "sptr"
; hMainMenu : HMENU -> "sptr"
; hInst : HINSTANCE -> "sptr"
; hwndStatus : HWND -> "sptr"
; lpwIDs : DWORD* -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; void MenuHelp(DWORD uMsg, WPARAM wParam, LPARAM lParam, HMENU hMainMenu, HINSTANCE hInst, HWND hwndStatus, DWORD* lpwIDs)
#uselib "COMCTL32.dll"
#func global MenuHelp "MenuHelp" int, intptr, intptr, intptr, intptr, intptr, var
; MenuHelp uMsg, wParam, lParam, hMainMenu, hInst, hwndStatus, lpwIDs
; uMsg : DWORD -> "int"
; wParam : WPARAM -> "intptr"
; lParam : LPARAM -> "intptr"
; hMainMenu : HMENU -> "intptr"
; hInst : HINSTANCE -> "intptr"
; hwndStatus : HWND -> "intptr"
; lpwIDs : DWORD* -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	comctl32 = windows.NewLazySystemDLL("COMCTL32.dll")
	procMenuHelp = comctl32.NewProc("MenuHelp")
)

// uMsg (DWORD), wParam (WPARAM), lParam (LPARAM), hMainMenu (HMENU), hInst (HINSTANCE), hwndStatus (HWND), lpwIDs (DWORD*)
r1, _, err := procMenuHelp.Call(
	uintptr(uMsg),
	uintptr(wParam),
	uintptr(lParam),
	uintptr(hMainMenu),
	uintptr(hInst),
	uintptr(hwndStatus),
	uintptr(lpwIDs),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // void
procedure MenuHelp(
  uMsg: DWORD;   // DWORD
  wParam: NativeUInt;   // WPARAM
  lParam: NativeInt;   // LPARAM
  hMainMenu: THandle;   // HMENU
  hInst: THandle;   // HINSTANCE
  hwndStatus: THandle;   // HWND
  lpwIDs: Pointer   // DWORD*
); stdcall;
  external 'COMCTL32.dll' name 'MenuHelp';
result := DllCall("COMCTL32\MenuHelp"
    , "UInt", uMsg   ; DWORD
    , "UPtr", wParam   ; WPARAM
    , "Ptr", lParam   ; LPARAM
    , "Ptr", hMainMenu   ; HMENU
    , "Ptr", hInst   ; HINSTANCE
    , "Ptr", hwndStatus   ; HWND
    , "Ptr", lpwIDs   ; DWORD*
    , "Int")   ; return: void
●MenuHelp(uMsg, wParam, lParam, hMainMenu, hInst, hwndStatus, lpwIDs) = DLL("COMCTL32.dll", "int MenuHelp(dword, int, int, void*, void*, void*, void*)")
# 呼び出し: MenuHelp(uMsg, wParam, lParam, hMainMenu, hInst, hwndStatus, lpwIDs)
# uMsg : DWORD -> "dword"
# wParam : WPARAM -> "int"
# lParam : LPARAM -> "int"
# hMainMenu : HMENU -> "void*"
# hInst : HINSTANCE -> "void*"
# hwndStatus : HWND -> "void*"
# lpwIDs : DWORD* -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

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

typedef MenuHelpNative = Void Function(Uint32, UintPtr, IntPtr, Pointer<Void>, Pointer<Void>, Pointer<Void>, Pointer<Uint32>);
typedef MenuHelpDart = void Function(int, int, int, Pointer<Void>, Pointer<Void>, Pointer<Void>, Pointer<Uint32>);
final MenuHelp = DynamicLibrary.open('COMCTL32.dll')
    .lookupFunction<MenuHelpNative, MenuHelpDart>('MenuHelp');
// uMsg : DWORD -> Uint32
// wParam : WPARAM -> UintPtr
// lParam : LPARAM -> IntPtr
// hMainMenu : HMENU -> Pointer<Void>
// hInst : HINSTANCE -> Pointer<Void>
// hwndStatus : HWND -> Pointer<Void>
// lpwIDs : DWORD* -> Pointer<Uint32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
procedure MenuHelp(
  uMsg: DWORD;   // DWORD
  wParam: NativeUInt;   // WPARAM
  lParam: NativeInt;   // LPARAM
  hMainMenu: THandle;   // HMENU
  hInst: THandle;   // HINSTANCE
  hwndStatus: THandle;   // HWND
  lpwIDs: Pointer   // DWORD*
); stdcall;
  external 'COMCTL32.dll' name 'MenuHelp';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "MenuHelp"
  c_MenuHelp :: Word32 -> CUIntPtr -> CIntPtr -> Ptr () -> Ptr () -> Ptr () -> Ptr Word32 -> IO ()
-- uMsg : DWORD -> Word32
-- wParam : WPARAM -> CUIntPtr
-- lParam : LPARAM -> CIntPtr
-- hMainMenu : HMENU -> Ptr ()
-- hInst : HINSTANCE -> Ptr ()
-- hwndStatus : HWND -> Ptr ()
-- lpwIDs : DWORD* -> Ptr Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let menuhelp =
  foreign "MenuHelp"
    (uint32_t @-> size_t @-> intptr_t @-> (ptr void) @-> (ptr void) @-> (ptr void) @-> (ptr uint32_t) @-> returning void)
(* uMsg : DWORD -> uint32_t *)
(* wParam : WPARAM -> size_t *)
(* lParam : LPARAM -> intptr_t *)
(* hMainMenu : HMENU -> (ptr void) *)
(* hInst : HINSTANCE -> (ptr void) *)
(* hwndStatus : HWND -> (ptr void) *)
(* lpwIDs : DWORD* -> (ptr uint32_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library comctl32 (t "COMCTL32.dll"))
(cffi:use-foreign-library comctl32)

(cffi:defcfun ("MenuHelp" menu-help :convention :stdcall) :void
  (u-msg :uint32)   ; DWORD
  (w-param :uint64)   ; WPARAM
  (l-param :int64)   ; LPARAM
  (h-main-menu :pointer)   ; HMENU
  (h-inst :pointer)   ; HINSTANCE
  (hwnd-status :pointer)   ; HWND
  (lpw-ids :pointer))   ; DWORD*
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $MenuHelp = Win32::API::More->new('COMCTL32',
    'void MenuHelp(DWORD uMsg, WPARAM wParam, LPARAM lParam, HANDLE hMainMenu, HANDLE hInst, HANDLE hwndStatus, LPVOID lpwIDs)');
# my $ret = $MenuHelp->Call($uMsg, $wParam, $lParam, $hMainMenu, $hInst, $hwndStatus, $lpwIDs);
# uMsg : DWORD -> DWORD
# wParam : WPARAM -> WPARAM
# lParam : LPARAM -> LPARAM
# hMainMenu : HMENU -> HANDLE
# hInst : HINSTANCE -> HANDLE
# hwndStatus : HWND -> HANDLE
# lpwIDs : DWORD* -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。