ホーム › System.Ole › OleRegGetMiscStatus

OleRegGetMiscStatus

関数

レジストリからオブジェクトのその他のステータス情報を取得する。

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

シグネチャ

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

HRESULT OleRegGetMiscStatus(
    const GUID* clsid,
    DWORD dwAspect,
    DWORD* pdwStatus
);

パラメーター

名前	型	方向	説明
clsid	GUID*	in	ステータス情報を要求する対象クラスの CLSID。
dwAspect	DWORD	in	情報を要求する対象クラスのプレゼンテーション側面。指定可能な値は DVASPECT 列挙体から取得します。
pdwStatus	DWORD*	out	ステータス情報を受け取る変数へのポインター。

戻り値の型: HRESULT

公式ドキュメント

指定された CLSID がサポートするプレゼンテーションおよび動作に関するさまざまな情報を、レジストリから返します。

戻り値

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

戻り値	説明
S_OK	ステータス情報が正常に返されました。
REGDB_E_CLASSNOTREG	クラスオブジェクトに対して CLSID が登録されていません。
REGDB_E_READREGDB	レジストリの読み取り中にエラーが発生しました。
OLE_E_REGDB_KEY	レジストリに GetMiscStatus キーが存在しません。

解説(Remarks)

オブジェクトアプリケーションは、2 通りの方法で OLE にさまざまなステータス情報の取得を要求できます。1 つ目の方法は OleRegGetMiscStatus を呼び出すことです。もう 1 つは、既定のオブジェクトハンドラーによる IOleObject::GetMiscStatus の呼び出しに応じて OLE_S_USEREG を返すことです。OLE_S_USEREG は、既定のハンドラーに OleRegGetMiscStatus を呼び出すよう指示します。DLL オブジェクトアプリケーションは OLE_S_USEREG を返せないため、処理をオブジェクトハンドラーに委譲するのではなく、OleRegGetMiscStatus を直接呼び出す必要があります。

OleRegGetMiscStatus およびその関連関数である OleRegGetUserType、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 OleRegGetMiscStatus(
    const GUID* clsid,
    DWORD dwAspect,
    DWORD* pdwStatus
);

[DllImport("OLE32.dll", ExactSpelling = true)]
static extern int OleRegGetMiscStatus(
    ref Guid clsid,   // GUID*
    uint dwAspect,   // DWORD
    out uint pdwStatus   // DWORD* out
);

<DllImport("OLE32.dll", ExactSpelling:=True)>
Public Shared Function OleRegGetMiscStatus(
    ByRef clsid As Guid,   ' GUID*
    dwAspect As UInteger,   ' DWORD
    <Out> ByRef pdwStatus As UInteger   ' DWORD* out
) As Integer
End Function

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

import ctypes
from ctypes import wintypes

OleRegGetMiscStatus = ctypes.windll.ole32.OleRegGetMiscStatus
OleRegGetMiscStatus.restype = ctypes.c_int
OleRegGetMiscStatus.argtypes = [
    ctypes.c_void_p,  # clsid : GUID*
    wintypes.DWORD,  # dwAspect : DWORD
    ctypes.POINTER(wintypes.DWORD),  # pdwStatus : DWORD* out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('OLE32.dll')
OleRegGetMiscStatus = Fiddle::Function.new(
  lib['OleRegGetMiscStatus'],
  [
    Fiddle::TYPE_VOIDP,  # clsid : GUID*
    -Fiddle::TYPE_INT,  # dwAspect : DWORD
    Fiddle::TYPE_VOIDP,  # pdwStatus : DWORD* out
  ],
  Fiddle::TYPE_INT)

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

$sig = @"
[DllImport("OLE32.dll")]
public static extern int OleRegGetMiscStatus(ref Guid clsid, uint dwAspect, out uint pdwStatus);
"@
$api = Add-Type -MemberDefinition $sig -Name 'OLE32_OleRegGetMiscStatus' -Namespace Win32 -PassThru
# $api::OleRegGetMiscStatus(clsid, dwAspect, pdwStatus)

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

出力引数:

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