ホーム › System.Ole › OleRegEnumFormatEtc

OleRegEnumFormatEtc

関数

レジストリ情報からオブジェクトの対応形式を列挙する。

DLLOLE32.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

HRESULT OleRegEnumFormatEtc(
    const GUID* clsid,
    DWORD dwDirection,
    IEnumFORMATETC** ppenum
);

パラメーター

名前	型	方向	説明
clsid	GUID*	in	形式を要求する対象クラスの CLSID。
dwDirection	DWORD	in	IDataObject::GetData に渡すことができる形式を列挙するか、IDataObject::SetData に渡すことができる形式を列挙するかを示します。指定できる値は列挙型 DATADIR から取得します。
ppenum	IEnumFORMATETC**	out	列挙オブジェクトへのインターフェイスポインターを受け取る IEnumFORMATETC ポインター変数のアドレス。

戻り値の型: HRESULT

公式ドキュメント

OLE オブジェクトサーバーがシステムレジストリに登録したデータ形式を列挙するために使用できる列挙オブジェクトを作成します。

戻り値

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

戻り値	説明
E_OUTOFMEMORY	操作を行うためのメモリが不足しています。
REGDB_E_CLASSNOTREG	クラスオブジェクトに対して登録された CLSID がありません。
REGDB_E_READREGDB	レジストリの読み取り中にエラーが発生しました。
OLE_E_REGDB_KEY	DataFormats/GetSet キーがレジストリにありません。

解説(Remarks)

オブジェクトアプリケーションは、サポートするデータ形式を列挙するために、FORMATETC 構造体用の列挙オブジェクトを OLE に作成させる方法を、次の 2 通りのいずれかで利用できます。1 つは OleRegEnumFormatEtc を呼び出す方法です。もう 1 つは、既定のオブジェクトハンドラーによる IDataObject::EnumFormatEtc の呼び出しに応じて OLE_S_USEREG を返す方法です。OLE_S_USEREG は、既定のハンドラーに対して OleRegEnumFormatEtc を呼び出すよう指示します。DLL オブジェクトアプリケーションは OLE_S_USEREG を返すことができないため、処理をオブジェクトハンドラーに委ねるのではなく、OleRegEnumFormatEtc を直接呼び出す必要があります。提供された IEnumFORMATETC ポインターを使用すると、標準の列挙オブジェクトメソッドを呼び出して列挙を実行できます。

OleRegEnumFormatEtc 関数と、その関連関数である OleRegGetUserType、OleRegGetMiscStatus、OleRegEnumVerbs は、カスタム 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 OleRegEnumFormatEtc(
    const GUID* clsid,
    DWORD dwDirection,
    IEnumFORMATETC** ppenum
);

[DllImport("OLE32.dll", ExactSpelling = true)]
static extern int OleRegEnumFormatEtc(
    ref Guid clsid,   // GUID*
    uint dwDirection,   // DWORD
    IntPtr ppenum   // IEnumFORMATETC** out
);

<DllImport("OLE32.dll", ExactSpelling:=True)>
Public Shared Function OleRegEnumFormatEtc(
    ByRef clsid As Guid,   ' GUID*
    dwDirection As UInteger,   ' DWORD
    ppenum As IntPtr   ' IEnumFORMATETC** out
) As Integer
End Function

' clsid : GUID*
' dwDirection : DWORD
' ppenum : IEnumFORMATETC** out
Declare PtrSafe Function OleRegEnumFormatEtc Lib "ole32" ( _
    ByVal clsid As LongPtr, _
    ByVal dwDirection As Long, _
    ByVal ppenum As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

OleRegEnumFormatEtc = ctypes.windll.ole32.OleRegEnumFormatEtc
OleRegEnumFormatEtc.restype = ctypes.c_int
OleRegEnumFormatEtc.argtypes = [
    ctypes.c_void_p,  # clsid : GUID*
    wintypes.DWORD,  # dwDirection : DWORD
    ctypes.c_void_p,  # ppenum : IEnumFORMATETC** out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('OLE32.dll')
OleRegEnumFormatEtc = Fiddle::Function.new(
  lib['OleRegEnumFormatEtc'],
  [
    Fiddle::TYPE_VOIDP,  # clsid : GUID*
    -Fiddle::TYPE_INT,  # dwDirection : DWORD
    Fiddle::TYPE_VOIDP,  # ppenum : IEnumFORMATETC** out
  ],
  Fiddle::TYPE_INT)

#[link(name = "ole32")]
extern "system" {
    fn OleRegEnumFormatEtc(
        clsid: *const GUID,  // GUID*
        dwDirection: u32,  // DWORD
        ppenum: *mut *mut core::ffi::c_void  // IEnumFORMATETC** out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("OLE32.dll")]
public static extern int OleRegEnumFormatEtc(ref Guid clsid, uint dwDirection, IntPtr ppenum);
"@
$api = Add-Type -MemberDefinition $sig -Name 'OLE32_OleRegEnumFormatEtc' -Namespace Win32 -PassThru
# $api::OleRegEnumFormatEtc(clsid, dwDirection, ppenum)

#uselib "OLE32.dll"
#func global OleRegEnumFormatEtc "OleRegEnumFormatEtc" sptr, sptr, sptr
; OleRegEnumFormatEtc varptr(clsid), dwDirection, ppenum   ; 戻り値は stat
; clsid : GUID* -> "sptr"
; dwDirection : DWORD -> "sptr"
; ppenum : IEnumFORMATETC** out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "OLE32.dll"
#cfunc global OleRegEnumFormatEtc "OleRegEnumFormatEtc" var, int, sptr
; res = OleRegEnumFormatEtc(clsid, dwDirection, ppenum)
; clsid : GUID* -> "var"
; dwDirection : DWORD -> "int"
; ppenum : IEnumFORMATETC** out -> "sptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "OLE32.dll"
#cfunc global OleRegEnumFormatEtc "OleRegEnumFormatEtc" sptr, int, sptr
; res = OleRegEnumFormatEtc(varptr(clsid), dwDirection, ppenum)
; clsid : GUID* -> "sptr"
; dwDirection : DWORD -> "int"
; ppenum : IEnumFORMATETC** out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。