OleGetAutoConvert

関数

指定CLSIDに設定された自動変換先のCLSIDを取得する。

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

シグネチャ

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

HRESULT OleGetAutoConvert(
    const GUID* clsidOld,
    GUID* pClsidNew
);

パラメーター

名前	型	方向	説明
clsidOld	GUID*	in	対象オブジェクトの CLSID。
pClsidNew	GUID*	out	新しい CLSID がある場合に、それを受け取る変数へのポインター。clsidOld の自動変換がレジストリに設定されていない場合は、clsidOld が返されます。pClsidNew パラメーターが NULL になることはありません。

戻り値の型: HRESULT

公式ドキュメント

指定した CLSID のオブジェクトを別の CLSID へ自動変換するようレジストリが設定されているかどうかを判定し、設定されている場合は新しい CLSID を取得します。

戻り値

この関数は、標準の戻り値 E_INVALIDARG、E_OUTOFMEMORY、E_UNEXPECTED に加えて、次の値を返すことがあります。

戻り値	説明
S_OK	pclsidNew パラメーターを通じて値が正常に返されました。
REGDB_E_CLASSNOTREG	CLSID がレジストリに正しく登録されていません。
REGDB_E_READREGDB	レジストリからの読み取りでエラーが発生しました。
REGDB_E_KEYMISSING	自動変換が有効でないか、clsidOld パラメーターに対応するレジストリエントリがありませんでした。

解説(Remarks)

OleGetAutoConvert は、指定したオブジェクトに対するレジストリ内の AutoConvertTo エントリを返します。AutoConvertTo サブキーは、特定の CLSID のオブジェクトを新しい CLSID へ自動的に変換するかどうかを指定します。これは通常、古いバージョンのアプリケーションで作成されたファイルを現在のバージョン用に変換するために使用されます。AutoConvertTo エントリが存在しない場合、この関数は clsidOld の値を返します。

OleDoAutoConvert 関数は、指定したオブジェクトを変換するかどうかを判定するために OleGetAutoConvert を呼び出します。オブジェクト変換をサポートするコンテナーアプリケーションは、オブジェクトを読み込むたびに OleDoAutoConvert を呼び出すべきです。コンテナーが OleLoad ヘルパー関数を使用する場合、OleLoad が内部で OleDoAutoConvert を呼び出すため、明示的に OleDoAutoConvert を呼び出す必要はありません。

特定のクラスの自動変換を設定するには、OleSetAutoConvert 関数を呼び出します(通常はアプリケーションインストールのセットアッププログラム内で行います)。この関数は AutoConvertTo サブキーを使用して、あるクラスのオブジェクトを別のクラスのオブジェクトへ自動変換するようタグ付けします。これは CLSID キーのサブキーです。

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

各言語での呼び出し定義

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

HRESULT OleGetAutoConvert(
    const GUID* clsidOld,
    GUID* pClsidNew
);

[DllImport("OLE32.dll", ExactSpelling = true)]
static extern int OleGetAutoConvert(
    ref Guid clsidOld,   // GUID*
    out Guid pClsidNew   // GUID* out
);

<DllImport("OLE32.dll", ExactSpelling:=True)>
Public Shared Function OleGetAutoConvert(
    ByRef clsidOld As Guid,   ' GUID*
    <Out> ByRef pClsidNew As Guid   ' GUID* out
) As Integer
End Function

' clsidOld : GUID*
' pClsidNew : GUID* out
Declare PtrSafe Function OleGetAutoConvert Lib "ole32" ( _
    ByVal clsidOld As LongPtr, _
    ByVal pClsidNew As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

OleGetAutoConvert = ctypes.windll.ole32.OleGetAutoConvert
OleGetAutoConvert.restype = ctypes.c_int
OleGetAutoConvert.argtypes = [
    ctypes.c_void_p,  # clsidOld : GUID*
    ctypes.c_void_p,  # pClsidNew : GUID* out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('OLE32.dll')
OleGetAutoConvert = Fiddle::Function.new(
  lib['OleGetAutoConvert'],
  [
    Fiddle::TYPE_VOIDP,  # clsidOld : GUID*
    Fiddle::TYPE_VOIDP,  # pClsidNew : GUID* out
  ],
  Fiddle::TYPE_INT)

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

$sig = @"
[DllImport("OLE32.dll")]
public static extern int OleGetAutoConvert(ref Guid clsidOld, out Guid pClsidNew);
"@
$api = Add-Type -MemberDefinition $sig -Name 'OLE32_OleGetAutoConvert' -Namespace Win32 -PassThru
# $api::OleGetAutoConvert(clsidOld, pClsidNew)

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

出力引数:

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