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

SetMenuItemInfoW

関数
メニュー項目の詳細情報を設定する(Unicode版)。
DLLUSER32.dll文字セットUnicode (-W)呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

// USER32.dll  (Unicode / -W)
#include <windows.h>

BOOL SetMenuItemInfoW(
    HMENU hmenu,
    DWORD item,
    BOOL fByPositon,
    MENUITEMINFOW* lpmii
);

パラメーター

名前方向説明
hmenuHMENUin対象のメニュー項目を含むメニューのハンドルです。
itemDWORDin変更するメニュー項目の識別子または位置です。このパラメーターの意味は fByPositon の値によって異なります。
fByPositonBOOLinItem の意味を指定します。このパラメーターが FALSE の場合、Item はメニュー項目の識別子です。それ以外の場合は、メニュー項目の位置です。詳細については「About Menus」を参照してください。(注: このパラメーターはヘッダー内でスペルが誤っていますが、ここに示すとおりに使用してください。)
lpmiiMENUITEMINFOW*inメニュー項目に関する情報を格納し、変更するメニュー項目の属性を指定する MENUITEMINFO 構造体へのポインターです。

戻り値の型: BOOL

公式ドキュメント

メニュー項目に関する情報を変更します。(Unicode)

戻り値

型: BOOL

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

関数が失敗した場合、戻り値は 0 になります。拡張エラー情報を取得するには、GetLastError 関数を使用してください。

解説(Remarks)

メニューが変更されたときは、そのメニューが表示中のウィンドウにあるかどうかにかかわらず、アプリケーションは必ず DrawMenuBar 関数を呼び出す必要があります。

ビットマップ メニュー項目やオーナー描画メニュー項目でキーボード アクセラレーターを機能させるには、メニューの所有者が WM_MENUCHAR メッセージを処理する必要があります。詳細については「Owner-Drawn Menus and the WM_MENUCHAR Message」を参照してください。

例については「Example of Owner-Drawn Menu Items」を参照してください。

メモ

winuser.h ヘッダーは SetMenuItemInfo をエイリアスとして定義しており、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択します。エンコーディング非依存のエイリアスの使用を、エンコーディング非依存でないコードと混在させると、不整合が生じ、コンパイル エラーや実行時エラーの原因となることがあります。詳細については「Conventions for Function Prototypes」を参照してください。

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

各言語での呼び出し定義

// USER32.dll  (Unicode / -W)
#include <windows.h>

BOOL SetMenuItemInfoW(
    HMENU hmenu,
    DWORD item,
    BOOL fByPositon,
    MENUITEMINFOW* lpmii
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("USER32.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern bool SetMenuItemInfoW(
    IntPtr hmenu,   // HMENU
    uint item,   // DWORD
    bool fByPositon,   // BOOL
    IntPtr lpmii   // MENUITEMINFOW*
);
<DllImport("USER32.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function SetMenuItemInfoW(
    hmenu As IntPtr,   ' HMENU
    item As UInteger,   ' DWORD
    fByPositon As Boolean,   ' BOOL
    lpmii As IntPtr   ' MENUITEMINFOW*
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' hmenu : HMENU
' item : DWORD
' fByPositon : BOOL
' lpmii : MENUITEMINFOW*
Declare PtrSafe Function SetMenuItemInfoW Lib "user32" ( _
    ByVal hmenu As LongPtr, _
    ByVal item As Long, _
    ByVal fByPositon As Long, _
    ByVal lpmii As LongPtr) As Long
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

SetMenuItemInfoW = ctypes.windll.user32.SetMenuItemInfoW
SetMenuItemInfoW.restype = wintypes.BOOL
SetMenuItemInfoW.argtypes = [
    wintypes.HANDLE,  # hmenu : HMENU
    wintypes.DWORD,  # item : DWORD
    wintypes.BOOL,  # fByPositon : BOOL
    ctypes.c_void_p,  # lpmii : MENUITEMINFOW*
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('USER32.dll')
SetMenuItemInfoW = Fiddle::Function.new(
  lib['SetMenuItemInfoW'],
  [
    Fiddle::TYPE_VOIDP,  # hmenu : HMENU
    -Fiddle::TYPE_INT,  # item : DWORD
    Fiddle::TYPE_INT,  # fByPositon : BOOL
    Fiddle::TYPE_VOIDP,  # lpmii : MENUITEMINFOW*
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "user32")]
extern "system" {
    fn SetMenuItemInfoW(
        hmenu: *mut core::ffi::c_void,  // HMENU
        item: u32,  // DWORD
        fByPositon: i32,  // BOOL
        lpmii: *mut MENUITEMINFOW  // MENUITEMINFOW*
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("USER32.dll", CharSet = CharSet.Unicode, SetLastError = true)]
public static extern bool SetMenuItemInfoW(IntPtr hmenu, uint item, bool fByPositon, IntPtr lpmii);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_SetMenuItemInfoW' -Namespace Win32 -PassThru
# $api::SetMenuItemInfoW(hmenu, item, fByPositon, lpmii)
#uselib "USER32.dll"
#func global SetMenuItemInfoW "SetMenuItemInfoW" wptr, wptr, wptr, wptr
; SetMenuItemInfoW hmenu, item, fByPositon, varptr(lpmii)   ; 戻り値は stat
; hmenu : HMENU -> "wptr"
; item : DWORD -> "wptr"
; fByPositon : BOOL -> "wptr"
; lpmii : MENUITEMINFOW* -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "USER32.dll"
#cfunc global SetMenuItemInfoW "SetMenuItemInfoW" sptr, int, int, var
; res = SetMenuItemInfoW(hmenu, item, fByPositon, lpmii)
; hmenu : HMENU -> "sptr"
; item : DWORD -> "int"
; fByPositon : BOOL -> "int"
; lpmii : MENUITEMINFOW* -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; BOOL SetMenuItemInfoW(HMENU hmenu, DWORD item, BOOL fByPositon, MENUITEMINFOW* lpmii)
#uselib "USER32.dll"
#cfunc global SetMenuItemInfoW "SetMenuItemInfoW" intptr, int, int, var
; res = SetMenuItemInfoW(hmenu, item, fByPositon, lpmii)
; hmenu : HMENU -> "intptr"
; item : DWORD -> "int"
; fByPositon : BOOL -> "int"
; lpmii : MENUITEMINFOW* -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	user32 = windows.NewLazySystemDLL("USER32.dll")
	procSetMenuItemInfoW = user32.NewProc("SetMenuItemInfoW")
)

// hmenu (HMENU), item (DWORD), fByPositon (BOOL), lpmii (MENUITEMINFOW*)
r1, _, err := procSetMenuItemInfoW.Call(
	uintptr(hmenu),
	uintptr(item),
	uintptr(fByPositon),
	uintptr(lpmii),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function SetMenuItemInfoW(
  hmenu: THandle;   // HMENU
  item: DWORD;   // DWORD
  fByPositon: BOOL;   // BOOL
  lpmii: Pointer   // MENUITEMINFOW*
): BOOL; stdcall;
  external 'USER32.dll' name 'SetMenuItemInfoW';
result := DllCall("USER32\SetMenuItemInfoW"
    , "Ptr", hmenu   ; HMENU
    , "UInt", item   ; DWORD
    , "Int", fByPositon   ; BOOL
    , "Ptr", lpmii   ; MENUITEMINFOW*
    , "Int")   ; return: BOOL
●SetMenuItemInfoW(hmenu, item, fByPositon, lpmii) = DLL("USER32.dll", "bool SetMenuItemInfoW(void*, dword, bool, void*)")
# 呼び出し: SetMenuItemInfoW(hmenu, item, fByPositon, lpmii)
# hmenu : HMENU -> "void*"
# item : DWORD -> "dword"
# fByPositon : BOOL -> "bool"
# lpmii : MENUITEMINFOW* -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。
const std = @import("std");

extern "user32" fn SetMenuItemInfoW(
    hmenu: ?*anyopaque, // HMENU
    item: u32, // DWORD
    fByPositon: i32, // BOOL
    lpmii: [*c]MENUITEMINFOW // MENUITEMINFOW*
) callconv(std.os.windows.WINAPI) i32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc SetMenuItemInfoW(
    hmenu: pointer,  # HMENU
    item: uint32,  # DWORD
    fByPositon: int32,  # BOOL
    lpmii: ptr MENUITEMINFOW  # MENUITEMINFOW*
): int32 {.importc: "SetMenuItemInfoW", stdcall, dynlib: "USER32.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "user32");
extern(Windows)
int SetMenuItemInfoW(
    void* hmenu,   // HMENU
    uint item,   // DWORD
    int fByPositon,   // BOOL
    MENUITEMINFOW* lpmii   // MENUITEMINFOW*
);
ccall((:SetMenuItemInfoW, "USER32.dll"), stdcall, Int32,
      (Ptr{Cvoid}, UInt32, Int32, Ptr{MENUITEMINFOW}),
      hmenu, item, fByPositon, lpmii)
# hmenu : HMENU -> Ptr{Cvoid}
# item : DWORD -> UInt32
# fByPositon : BOOL -> Int32
# lpmii : MENUITEMINFOW* -> Ptr{MENUITEMINFOW}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
int32_t SetMenuItemInfoW(
    void* hmenu,
    uint32_t item,
    int32_t fByPositon,
    void* lpmii);
]]
local user32 = ffi.load("user32")
-- user32.SetMenuItemInfoW(hmenu, item, fByPositon, lpmii)
-- hmenu : HMENU
-- item : DWORD
-- fByPositon : BOOL
-- lpmii : MENUITEMINFOW*
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- Unicode(-W): uint16_t* には UTF-16LE のバッファ(ffi.new("uint16_t[?]", ...))を渡す。
const koffi = require('koffi');
const lib = koffi.load('USER32.dll');
const SetMenuItemInfoW = lib.func('__stdcall', 'SetMenuItemInfoW', 'int32_t', ['void *', 'uint32_t', 'int32_t', 'void *']);
// SetMenuItemInfoW(hmenu, item, fByPositon, lpmii)
// hmenu : HMENU -> 'void *'
// item : DWORD -> 'uint32_t'
// fByPositon : BOOL -> 'int32_t'
// lpmii : MENUITEMINFOW* -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("USER32.dll", {
  SetMenuItemInfoW: { parameters: ["pointer", "u32", "i32", "pointer"], result: "i32" },
});
// lib.symbols.SetMenuItemInfoW(hmenu, item, fByPositon, lpmii)
// hmenu : HMENU -> "pointer"
// item : DWORD -> "u32"
// fByPositon : BOOL -> "i32"
// lpmii : MENUITEMINFOW* -> "pointer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t SetMenuItemInfoW(
    void* hmenu,
    uint32_t item,
    int32_t fByPositon,
    void* lpmii);
C, "USER32.dll");
// $ffi->SetMenuItemInfoW(hmenu, item, fByPositon, lpmii);
// hmenu : HMENU
// item : DWORD
// fByPositon : BOOL
// lpmii : MENUITEMINFOW*
// 構造体/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, W32APIOptions.UNICODE_OPTIONS);
    boolean SetMenuItemInfoW(
        Pointer hmenu,   // HMENU
        int item,   // DWORD
        boolean fByPositon,   // BOOL
        Pointer lpmii   // MENUITEMINFOW*
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("user32")]
lib LibUSER32
  fun SetMenuItemInfoW = SetMenuItemInfoW(
    hmenu : Void*,   # HMENU
    item : UInt32,   # DWORD
    fByPositon : Int32,   # BOOL
    lpmii : MENUITEMINFOW*   # MENUITEMINFOW*
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef SetMenuItemInfoWNative = Int32 Function(Pointer<Void>, Uint32, Int32, Pointer<Void>);
typedef SetMenuItemInfoWDart = int Function(Pointer<Void>, int, int, Pointer<Void>);
final SetMenuItemInfoW = DynamicLibrary.open('USER32.dll')
    .lookupFunction<SetMenuItemInfoWNative, SetMenuItemInfoWDart>('SetMenuItemInfoW');
// hmenu : HMENU -> Pointer<Void>
// item : DWORD -> Uint32
// fByPositon : BOOL -> Int32
// lpmii : MENUITEMINFOW* -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SetMenuItemInfoW(
  hmenu: THandle;   // HMENU
  item: DWORD;   // DWORD
  fByPositon: BOOL;   // BOOL
  lpmii: Pointer   // MENUITEMINFOW*
): BOOL; stdcall;
  external 'USER32.dll' name 'SetMenuItemInfoW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SetMenuItemInfoW"
  c_SetMenuItemInfoW :: Ptr () -> Word32 -> CInt -> Ptr () -> IO CInt
-- hmenu : HMENU -> Ptr ()
-- item : DWORD -> Word32
-- fByPositon : BOOL -> CInt
-- lpmii : MENUITEMINFOW* -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let setmenuiteminfow =
  foreign "SetMenuItemInfoW"
    ((ptr void) @-> uint32_t @-> int32_t @-> (ptr void) @-> returning int32_t)
(* hmenu : HMENU -> (ptr void) *)
(* item : DWORD -> uint32_t *)
(* fByPositon : BOOL -> int32_t *)
(* lpmii : MENUITEMINFOW* -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library user32 (t "USER32.dll"))
(cffi:use-foreign-library user32)

(cffi:defcfun ("SetMenuItemInfoW" set-menu-item-info-w :convention :stdcall) :int32
  (hmenu :pointer)   ; HMENU
  (item :uint32)   ; DWORD
  (f-by-positon :int32)   ; BOOL
  (lpmii :pointer))   ; MENUITEMINFOW*
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SetMenuItemInfoW = Win32::API::More->new('USER32',
    'BOOL SetMenuItemInfoW(HANDLE hmenu, DWORD item, BOOL fByPositon, LPVOID lpmii)');
# my $ret = $SetMenuItemInfoW->Call($hmenu, $item, $fByPositon, $lpmii);
# hmenu : HMENU -> HANDLE
# item : DWORD -> DWORD
# fByPositon : BOOL -> BOOL
# lpmii : MENUITEMINFOW* -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

文字セット違い
公式の関連項目
使用する型