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

OleRegEnumVerbs

関数
レジストリ情報からオブジェクトの動詞を列挙する。
DLLOLE32.dll呼出規約winapi対応OSWindows 2000 以降
📘 Microsoft Learn (日本語) · English

シグネチャ

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

HRESULT OleRegEnumVerbs(
    const GUID* clsid,
    IEnumOLEVERB** ppenum
);

パラメーター

名前型方向説明
clsidGUID*inverb の取得対象となるクラス識別子。
ppenumIEnumOLEVERB**out新しい列挙オブジェクトへのインターフェイスポインターを受け取る IEnumOLEVERB* ポインター変数のアドレス。

戻り値の型: HRESULT

公式ドキュメント

指定したクラスに登録されている verb の列挙を提供します。カスタム DLL オブジェクトアプリケーションの開発者は、この関数を使用してデフォルトのオブジェクトハンドラーの動作をエミュレートします。

戻り値

成功した場合、この関数は S_OK を返します。その他に返される可能性のある値は次のとおりです。

戻り値 説明
OLEOBJ_E_NOVERBS
 クラスに verb が登録されていません。
REGDB_E_CLASSNOTREG
 クラスオブジェクトに対して CLSID が登録されていません。
REGDB_E_READREGDB
 レジストリの読み取り中にエラーが発生しました。
OLE_E_REGDB_KEY
 DataFormats/GetSet キーがレジストリにありません。

解説(Remarks)

オブジェクトアプリケーションは、サポートする verb を列挙するために、OLEVERB 構造体用の列挙オブジェクトの作成を OLE に要求する方法として、2 つの方法のいずれかを使用できます。1 つは OleRegEnumVerbs を呼び出す方法です。もう 1 つは、デフォルトのオブジェクトハンドラーによる IOleObject::EnumVerbs の呼び出しに対して OLE_S_USEREG を返す方法です。OLE_S_USEREG は、OleRegEnumVerbs を呼び出すようデフォルトハンドラーに指示します。DLL オブジェクトアプリケーションは OLE_S_USEREG を返せないため、この処理をオブジェクトハンドラーに委譲するのではなく、OleRegEnumVerbs を呼び出す必要があります。提供されたオブジェクトへの IEnumOLEVERB ポインターを使用すると、標準の列挙オブジェクトメソッドを呼び出して列挙を実行できます。

OleRegEnumVerbs 関数とその関連関数である OleRegGetUserType、OleRegGetMiscStatus、OleRegEnumFormatEtc は、カスタム DLL オブジェクトアプリケーションの開発者が、レジストリからオブジェクトに関する情報を取得する際に OLE のデフォルトオブジェクトハンドラーの動作をエミュレートするための手段を提供します。これらの関数を使用することで、独自に実装するという相当な手間や、レジストリを直接操作することに伴う落とし穴を回避できます。さらに、これらの関数の今後の機能強化や最適化を、自分でコーディングすることなく利用できます。

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

各言語での呼び出し定義

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

HRESULT OleRegEnumVerbs(
    const GUID* clsid,
    IEnumOLEVERB** ppenum
);
[DllImport("OLE32.dll", ExactSpelling = true)]
static extern int OleRegEnumVerbs(
    ref Guid clsid,   // GUID*
    IntPtr ppenum   // IEnumOLEVERB** out
);
<DllImport("OLE32.dll", ExactSpelling:=True)>
Public Shared Function OleRegEnumVerbs(
    ByRef clsid As Guid,   ' GUID*
    ppenum As IntPtr   ' IEnumOLEVERB** out
) As Integer
End Function
' clsid : GUID*
' ppenum : IEnumOLEVERB** out
Declare PtrSafe Function OleRegEnumVerbs Lib "ole32" ( _
    ByVal clsid As LongPtr, _
    ByVal ppenum As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

OleRegEnumVerbs = ctypes.windll.ole32.OleRegEnumVerbs
OleRegEnumVerbs.restype = ctypes.c_int
OleRegEnumVerbs.argtypes = [
    ctypes.c_void_p,  # clsid : GUID*
    ctypes.c_void_p,  # ppenum : IEnumOLEVERB** out
]
require 'fiddle'
require 'fiddle/import'

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

var (
	ole32 = windows.NewLazySystemDLL("OLE32.dll")
	procOleRegEnumVerbs = ole32.NewProc("OleRegEnumVerbs")
)

// clsid (GUID*), ppenum (IEnumOLEVERB** out)
r1, _, err := procOleRegEnumVerbs.Call(
	uintptr(clsid),
	uintptr(ppenum),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // HRESULT
function OleRegEnumVerbs(
  clsid: PGUID;   // GUID*
  ppenum: Pointer   // IEnumOLEVERB** out
): Integer; stdcall;
  external 'OLE32.dll' name 'OleRegEnumVerbs';
result := DllCall("OLE32\OleRegEnumVerbs"
    , "Ptr", clsid   ; GUID*
    , "Ptr", ppenum   ; IEnumOLEVERB** out
    , "Int")   ; return: HRESULT
●OleRegEnumVerbs(clsid, ppenum) = DLL("OLE32.dll", "int OleRegEnumVerbs(void*, void*)")
# 呼び出し: OleRegEnumVerbs(clsid, ppenum)
# clsid : GUID* -> "void*"
# ppenum : IEnumOLEVERB** out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

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

typedef OleRegEnumVerbsNative = Int32 Function(Pointer<Void>, Pointer<Void>);
typedef OleRegEnumVerbsDart = int Function(Pointer<Void>, Pointer<Void>);
final OleRegEnumVerbs = DynamicLibrary.open('OLE32.dll')
    .lookupFunction<OleRegEnumVerbsNative, OleRegEnumVerbsDart>('OleRegEnumVerbs');
// clsid : GUID* -> Pointer<Void>
// ppenum : IEnumOLEVERB** out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function OleRegEnumVerbs(
  clsid: PGUID;   // GUID*
  ppenum: Pointer   // IEnumOLEVERB** out
): Integer; stdcall;
  external 'OLE32.dll' name 'OleRegEnumVerbs';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "OleRegEnumVerbs"
  c_OleRegEnumVerbs :: Ptr () -> Ptr () -> IO Int32
-- clsid : GUID* -> Ptr ()
-- ppenum : IEnumOLEVERB** out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let oleregenumverbs =
  foreign "OleRegEnumVerbs"
    ((ptr void) @-> (ptr void) @-> returning int32_t)
(* clsid : GUID* -> (ptr void) *)
(* ppenum : IEnumOLEVERB** out -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library ole32 (t "OLE32.dll"))
(cffi:use-foreign-library ole32)

(cffi:defcfun ("OleRegEnumVerbs" ole-reg-enum-verbs :convention :stdcall) :int32
  (clsid :pointer)   ; GUID*
  (ppenum :pointer))   ; IEnumOLEVERB** out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $OleRegEnumVerbs = Win32::API::More->new('OLE32',
    'int OleRegEnumVerbs(LPVOID clsid, LPVOID ppenum)');
# my $ret = $OleRegEnumVerbs->Call($clsid, $ppenum);
# clsid : GUID* -> LPVOID
# ppenum : IEnumOLEVERB** out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型