OleRegGetUserType

関数

レジストリからCLSIDのユーザー表示用タイプ名を取得する。

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

シグネチャ

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

HRESULT OleRegGetUserType(
    const GUID* clsid,
    DWORD dwFormOfType,
    LPWSTR* pszUserType
);

パラメーター

名前	型	方向	説明
clsid	GUID*	in	ユーザータイプを取得する対象クラスの CLSID。
dwFormOfType	DWORD	in	ユーザーに提示する文字列の形式。指定可能な値は列挙型 USERCLASSTYPE から取得します。
pszUserType	LPWSTR*	out	ユーザータイプを受け取る文字列へのポインター。

戻り値の型: HRESULT

公式ドキュメント

指定したクラスのユーザータイプをレジストリから取得します。

戻り値

この関数は、標準の戻り値 E_OUTOFMEMORY のほか、次の値を返すことがあります。

戻り値	説明
S_OK	ユーザータイプが正常に返されました。
REGDB_E_CLASSNOTREG	クラスオブジェクトに対して CLSID が登録されていません。
REGDB_E_READREGDB	レジストリの読み取り中にエラーが発生しました。
OLE_E_REGDB_KEY	ProgID = MainUserTypeName キーおよび CLSID = MainUserTypeName キーがレジストリに存在しません。

解説(Remarks)

オブジェクトアプリケーションは、指定したクラスのユーザータイプ名を取得するよう OLE に依頼するために、2 通りの方法を使用できます。1 つは OleRegGetUserType を呼び出す方法です。もう 1 つは、既定のオブジェクトハンドラーによる IOleObject::GetUserType の呼び出しに応答して OLE_S_USEREG を返す方法です。OLE_S_USEREG は、既定のハンドラーに OleRegGetUserType を呼び出すよう指示します。DLL オブジェクトアプリケーションは OLE_S_USEREG を返せないため、処理をオブジェクトハンドラーに委ねるのではなく、OleRegGetUserType を直接呼び出す必要があります。

OleRegGetUserType 関数と、その関連関数である OleRegGetMiscStatus、OleRegEnumFormatEtc、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 OleRegGetUserType(
    const GUID* clsid,
    DWORD dwFormOfType,
    LPWSTR* pszUserType
);

[DllImport("OLE32.dll", ExactSpelling = true)]
static extern int OleRegGetUserType(
    ref Guid clsid,   // GUID*
    uint dwFormOfType,   // DWORD
    IntPtr pszUserType   // LPWSTR* out
);

<DllImport("OLE32.dll", ExactSpelling:=True)>
Public Shared Function OleRegGetUserType(
    ByRef clsid As Guid,   ' GUID*
    dwFormOfType As UInteger,   ' DWORD
    pszUserType As IntPtr   ' LPWSTR* out
) As Integer
End Function

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

import ctypes
from ctypes import wintypes

OleRegGetUserType = ctypes.windll.ole32.OleRegGetUserType
OleRegGetUserType.restype = ctypes.c_int
OleRegGetUserType.argtypes = [
    ctypes.c_void_p,  # clsid : GUID*
    wintypes.DWORD,  # dwFormOfType : DWORD
    ctypes.c_void_p,  # pszUserType : LPWSTR* out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('OLE32.dll')
OleRegGetUserType = Fiddle::Function.new(
  lib['OleRegGetUserType'],
  [
    Fiddle::TYPE_VOIDP,  # clsid : GUID*
    -Fiddle::TYPE_INT,  # dwFormOfType : DWORD
    Fiddle::TYPE_VOIDP,  # pszUserType : LPWSTR* out
  ],
  Fiddle::TYPE_INT)

#[link(name = "ole32")]
extern "system" {
    fn OleRegGetUserType(
        clsid: *const GUID,  // GUID*
        dwFormOfType: u32,  // DWORD
        pszUserType: *mut *mut u16  // LPWSTR* out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

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

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

出力引数:

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