Win32 API 日本語リファレンス
ホームSystem.Ole › OleCreateMenuDescriptor

OleCreateMenuDescriptor

関数
OLEメニュー合成用のメニュー記述子を作成する。
DLLOLE32.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

INT_PTR OleCreateMenuDescriptor(
    HMENU hmenuCombined,
    OLEMENUGROUPWIDTHS* lpMenuWidths
);

パラメーター

名前方向説明
hmenuCombinedHMENUinオブジェクトが作成した結合メニューへのハンドル。
lpMenuWidthsOLEMENUGROUPWIDTHS*in各グループ内のメニュー数を示す 6 個の LONG 値の配列へのポインター。

戻り値の型: INT_PTR

公式ドキュメント

OLE がメニューのメッセージおよびコマンドをディスパッチする際に使用する OLE メニュー記述子(すなわち、メニューを記述するために OLE が提供するデータ構造)を作成して返します。

戻り値

記述子へのハンドルを返します。メモリが不足している場合は NULL を返します。

解説(Remarks)

OleCreateMenuDescriptor 関数は、複合メニューの記述子を作成するためにオブジェクトから呼び出すことができます。OLE はこの記述子を使用して、メニューのメッセージおよびコマンドをディスパッチします。共有メニュー記述子が不要になった際にそれを解放するには、コンテナーは対になるヘルパー関数 OleDestroyMenuDescriptor を呼び出す必要があります。

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

各言語での呼び出し定義

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

INT_PTR OleCreateMenuDescriptor(
    HMENU hmenuCombined,
    OLEMENUGROUPWIDTHS* lpMenuWidths
);
[DllImport("OLE32.dll", ExactSpelling = true)]
static extern IntPtr OleCreateMenuDescriptor(
    IntPtr hmenuCombined,   // HMENU
    IntPtr lpMenuWidths   // OLEMENUGROUPWIDTHS*
);
<DllImport("OLE32.dll", ExactSpelling:=True)>
Public Shared Function OleCreateMenuDescriptor(
    hmenuCombined As IntPtr,   ' HMENU
    lpMenuWidths As IntPtr   ' OLEMENUGROUPWIDTHS*
) As IntPtr
End Function
' hmenuCombined : HMENU
' lpMenuWidths : OLEMENUGROUPWIDTHS*
Declare PtrSafe Function OleCreateMenuDescriptor Lib "ole32" ( _
    ByVal hmenuCombined As LongPtr, _
    ByVal lpMenuWidths As LongPtr) As LongPtr
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

OleCreateMenuDescriptor = ctypes.windll.ole32.OleCreateMenuDescriptor
OleCreateMenuDescriptor.restype = ctypes.c_ssize_t
OleCreateMenuDescriptor.argtypes = [
    wintypes.HANDLE,  # hmenuCombined : HMENU
    ctypes.c_void_p,  # lpMenuWidths : OLEMENUGROUPWIDTHS*
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('OLE32.dll')
OleCreateMenuDescriptor = Fiddle::Function.new(
  lib['OleCreateMenuDescriptor'],
  [
    Fiddle::TYPE_VOIDP,  # hmenuCombined : HMENU
    Fiddle::TYPE_VOIDP,  # lpMenuWidths : OLEMENUGROUPWIDTHS*
  ],
  Fiddle::TYPE_INTPTR_T)
#[link(name = "ole32")]
extern "system" {
    fn OleCreateMenuDescriptor(
        hmenuCombined: *mut core::ffi::c_void,  // HMENU
        lpMenuWidths: *mut OLEMENUGROUPWIDTHS  // OLEMENUGROUPWIDTHS*
    ) -> isize;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("OLE32.dll")]
public static extern IntPtr OleCreateMenuDescriptor(IntPtr hmenuCombined, IntPtr lpMenuWidths);
"@
$api = Add-Type -MemberDefinition $sig -Name 'OLE32_OleCreateMenuDescriptor' -Namespace Win32 -PassThru
# $api::OleCreateMenuDescriptor(hmenuCombined, lpMenuWidths)
#uselib "OLE32.dll"
#func global OleCreateMenuDescriptor "OleCreateMenuDescriptor" sptr, sptr
; OleCreateMenuDescriptor hmenuCombined, varptr(lpMenuWidths)   ; 戻り値は stat
; hmenuCombined : HMENU -> "sptr"
; lpMenuWidths : OLEMENUGROUPWIDTHS* -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "OLE32.dll"
#cfunc global OleCreateMenuDescriptor "OleCreateMenuDescriptor" sptr, var
; res = OleCreateMenuDescriptor(hmenuCombined, lpMenuWidths)
; hmenuCombined : HMENU -> "sptr"
; lpMenuWidths : OLEMENUGROUPWIDTHS* -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; INT_PTR OleCreateMenuDescriptor(HMENU hmenuCombined, OLEMENUGROUPWIDTHS* lpMenuWidths)
#uselib "OLE32.dll"
#cfunc global OleCreateMenuDescriptor "OleCreateMenuDescriptor" intptr, var
; res = OleCreateMenuDescriptor(hmenuCombined, lpMenuWidths)
; hmenuCombined : HMENU -> "intptr"
; lpMenuWidths : OLEMENUGROUPWIDTHS* -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	ole32 = windows.NewLazySystemDLL("OLE32.dll")
	procOleCreateMenuDescriptor = ole32.NewProc("OleCreateMenuDescriptor")
)

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

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

typedef OleCreateMenuDescriptorNative = IntPtr Function(Pointer<Void>, Pointer<Void>);
typedef OleCreateMenuDescriptorDart = int Function(Pointer<Void>, Pointer<Void>);
final OleCreateMenuDescriptor = DynamicLibrary.open('OLE32.dll')
    .lookupFunction<OleCreateMenuDescriptorNative, OleCreateMenuDescriptorDart>('OleCreateMenuDescriptor');
// hmenuCombined : HMENU -> Pointer<Void>
// lpMenuWidths : OLEMENUGROUPWIDTHS* -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function OleCreateMenuDescriptor(
  hmenuCombined: THandle;   // HMENU
  lpMenuWidths: Pointer   // OLEMENUGROUPWIDTHS*
): NativeInt; stdcall;
  external 'OLE32.dll' name 'OleCreateMenuDescriptor';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "OleCreateMenuDescriptor"
  c_OleCreateMenuDescriptor :: Ptr () -> Ptr () -> IO CIntPtr
-- hmenuCombined : HMENU -> Ptr ()
-- lpMenuWidths : OLEMENUGROUPWIDTHS* -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let olecreatemenudescriptor =
  foreign "OleCreateMenuDescriptor"
    ((ptr void) @-> (ptr void) @-> returning intptr_t)
(* hmenuCombined : HMENU -> (ptr void) *)
(* lpMenuWidths : OLEMENUGROUPWIDTHS* -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library ole32 (t "OLE32.dll"))
(cffi:use-foreign-library ole32)

(cffi:defcfun ("OleCreateMenuDescriptor" ole-create-menu-descriptor :convention :stdcall) :int64
  (hmenu-combined :pointer)   ; HMENU
  (lp-menu-widths :pointer))   ; OLEMENUGROUPWIDTHS*
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $OleCreateMenuDescriptor = Win32::API::More->new('OLE32',
    'LPARAM OleCreateMenuDescriptor(HANDLE hmenuCombined, LPVOID lpMenuWidths)');
# my $ret = $OleCreateMenuDescriptor->Call($hmenuCombined, $lpMenuWidths);
# hmenuCombined : HMENU -> HANDLE
# lpMenuWidths : OLEMENUGROUPWIDTHS* -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目
使用する型