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

OleSetAutoConvert

関数
あるCLSIDから別のCLSIDへの自動変換を設定する。
DLLOLE32.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

HRESULT OleSetAutoConvert(
    const GUID* clsidOld,
    const GUID* clsidNew
);

パラメーター

名前方向説明
clsidOldGUID*in変換対象となるオブジェクトクラスの CLSID です。
clsidNewGUID*inclsidOld を置き換えるオブジェクトクラスの CLSID です。この新しい CLSID は、レジストリ内の clsidOld に対する既存の自動変換情報を置き換えます。この値が CLSID_NULL の場合、clsidOld に対する既存の自動変換情報がレジストリから削除されます。

戻り値の型: HRESULT

公式ドキュメント

指定したクラスのオブジェクトが読み込まれた際に、別のクラスへ自動変換するための CLSID を指定します。

戻り値

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

戻り値 説明
S_OK
オブジェクトのタグ付けに成功しました。
REGDB_E_CLASSNOTREG
CLSID がレジストリに正しく登録されていません。
REGDB_E_READREGDB
レジストリからの読み取りでエラーが発生しました。
REGDB_E_WRITEREGDB
レジストリへの書き込みでエラーが発生しました。
REGDB_E_KEYMISSING
レジストリからキーを読み取れません。

解説(Remarks)

OleSetAutoConvert はシステムレジストリにアクセスし、clsidOld で指定された CLSID の下にある AutoConvertTo サブキーを見つけて、clsidNew を設定します。この関数は、clsidNew に対応する適切なレジストリエントリが現在存在するかどうかの検証は行いません。これらのエントリは、CLSID キーのサブキーとしてレジストリに現れます。

オブジェクトの変換とは、オブジェクトのデータが新しい CLSID に恒久的に関連付けられることを意味します。自動変換は通常、新しいバージョンのオブジェクトアプリケーションのセットアッププログラムで指定されます。これにより、古いバージョンで作成されたオブジェクトを新しいバージョンへ自動的に更新できます。

たとえば、以前のバージョンの表計算アプリケーションで作成されたスプレッドシートを、新しいバージョンへ変換する必要が生じることがあります。以前のバージョンのスプレッドシートオブジェクトは、新しいバージョンとは異なる CLSID を持っています。自動更新したい以前の各バージョンについて、セットアッププログラム内で OleSetAutoConvert を呼び出し、古いバージョンの CLSID と新しいバージョンの CLSID を指定します。これにより、ユーザーが以前のバージョンのオブジェクトを読み込むたびに、自動的に更新されます。オブジェクトの自動変換をサポートするには、変換に対応するサーバーが、以前のバージョンのサーバーの形式を持つオブジェクトを手動で変換できるように準備されている必要があります。自動変換は、内部的にこの手動変換のサポートに依存しています。

目的の AutoConvertTo 値を設定する前に、セットアッププログラムは、新しいクラスを clsidOld パラメーターとして指定し、clsidNew パラメーターを CLSID_NULL に設定して OleSetAutoConvert を呼び出し、新しいクラスに対する既存の変換設定を削除しておく必要があります。

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

各言語での呼び出し定義

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

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

OleSetAutoConvert = ctypes.windll.ole32.OleSetAutoConvert
OleSetAutoConvert.restype = ctypes.c_int
OleSetAutoConvert.argtypes = [
    ctypes.c_void_p,  # clsidOld : GUID*
    ctypes.c_void_p,  # clsidNew : GUID*
]
require 'fiddle'
require 'fiddle/import'

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

var (
	ole32 = windows.NewLazySystemDLL("OLE32.dll")
	procOleSetAutoConvert = ole32.NewProc("OleSetAutoConvert")
)

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

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

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

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

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

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

関連項目

公式の関連項目