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

RegisterActiveObject

関数
実行中オブジェクトをアクティブオブジェクトとして登録する。
DLLOLEAUT32.dll呼出規約winapi
📘 Microsoft Learn (日本語) · English

シグネチャ

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

HRESULT RegisterActiveObject(
    IUnknown* punk,
    const GUID* rclsid,
    ACTIVEOBJECT_FLAGS dwFlags,
    DWORD* pdwRegister
);

パラメーター

名前型方向説明
punkIUnknown*inアクティブオブジェクト。
rclsidGUID*inアクティブオブジェクトの CLSID。
dwFlagsACTIVEOBJECT_FLAGSinオブジェクトの登録を制御するフラグ。指定できる値は ACTIVEOBJECT_STRONG および ACTIVEOBJECT_WEAK です。
pdwRegisterDWORD*inoutハンドルを受け取ります。このハンドルは、オブジェクトのアクティブ状態を終了させるために RevokeActiveObject へ渡す必要があります。

戻り値の型: HRESULT

公式ドキュメント

オブジェクトをそのクラスのアクティブオブジェクトとして登録します。

戻り値

この関数が成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

解説(Remarks)

RegisterActiveObject 関数は、punk が指すオブジェクトを rclsid で示されるクラスのアクティブオブジェクトとして登録します。登録すると、オブジェクトは OLE の running object table (ROT) に列挙されます。ROT は、現在コンピューター上で実行中のオブジェクトを追跡する、グローバルにアクセス可能なルックアップテーブルです。(running object table の詳細については、COM Programmer's Reference を参照してください。)dwFlags パラメーターは登録の強弱を指定し、これによってオブジェクトのシャットダウン方法が変わります。

一般に、ActiveX オブジェクトは次のように振る舞う必要があります。

Strong 登録はオブジェクトに対して AddRef を実行し、running object table 内のオブジェクト(およびそれに関連付けられたスタブ)の参照カウントをインクリメントします。Strong 登録されたオブジェクトは、RevokeActiveObject によってテーブルから明示的に取り消す必要があります。既定は strong 登録(ACTIVEOBJECT_STRONG)です。

Weak 登録は running object table 内にオブジェクトへのポインターを保持しますが、参照カウントはインクリメントしません。そのため、weak 登録されたオブジェクトへの外部からの最後の接続がなくなると、OLE はオブジェクトのスタブを解放し、オブジェクト自体は利用できなくなります。

目的の動作を確実にするには、OLE の既定の動作だけでなく、次の点も考慮してください。

競合の可能性を避けるため、ActiveX オブジェクトは常に ACTIVEOBJECT_WEAK で登録し、必要に応じて CoLockObjectExternal を呼び出して、オブジェクトがアクティブのままであることを保証してください。CoLockObjectExternal は strong ロックを追加し、これによってオブジェクトの参照カウントがゼロに達するのを防ぎます。この関数の詳細については、COM Programmer's Reference を参照してください。

最も一般的には、オブジェクトは表示状態になったときに CoLockObjectExternal を呼び出す必要があり、これによってユーザーがオブジェクトのシャットダウンを要求するまでアクティブのままになります。次の手順は、オブジェクトを正しくシャットダウンするためにコードが従うべきステップを示します。

アクティブオブジェクトをシャットダウンするには:

  1. オブジェクトが表示状態になったら、ユーザー用のロックを追加するために次の呼び出しを行います。 
    CoLockObjectExternal(punk, TRUE, TRUE)

    このロックは、Quit コマンドや Exit コマンドなどでユーザーがオブジェクトのシャットダウンを明示的に要求するまで有効です。

  2. ユーザーがオブジェクトのシャットダウンを要求したら、次のようにもう一度 CoLockObjectExternal を呼び出してロックを解放します。 
    CoLockObjectExternal(punk, FALSE, TRUE)
  3. RevokeActiveObject を呼び出してオブジェクトを非アクティブにします。
  4. リモートプロセスからのすべての接続を終了するには、次のように CoDisconnectObject を呼び出します。 
    CoDisconnectObject(punk,0)

    この関数の詳細については、COM Programmer's Reference で説明されています。

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

各言語での呼び出し定義

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

HRESULT RegisterActiveObject(
    IUnknown* punk,
    const GUID* rclsid,
    ACTIVEOBJECT_FLAGS dwFlags,
    DWORD* pdwRegister
);
[DllImport("OLEAUT32.dll", ExactSpelling = true)]
static extern int RegisterActiveObject(
    IntPtr punk,   // IUnknown*
    ref Guid rclsid,   // GUID*
    uint dwFlags,   // ACTIVEOBJECT_FLAGS
    ref uint pdwRegister   // DWORD* in/out
);
<DllImport("OLEAUT32.dll", ExactSpelling:=True)>
Public Shared Function RegisterActiveObject(
    punk As IntPtr,   ' IUnknown*
    ByRef rclsid As Guid,   ' GUID*
    dwFlags As UInteger,   ' ACTIVEOBJECT_FLAGS
    ByRef pdwRegister As UInteger   ' DWORD* in/out
) As Integer
End Function
' punk : IUnknown*
' rclsid : GUID*
' dwFlags : ACTIVEOBJECT_FLAGS
' pdwRegister : DWORD* in/out
Declare PtrSafe Function RegisterActiveObject Lib "oleaut32" ( _
    ByVal punk As LongPtr, _
    ByVal rclsid As LongPtr, _
    ByVal dwFlags As Long, _
    ByRef pdwRegister As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

RegisterActiveObject = ctypes.windll.oleaut32.RegisterActiveObject
RegisterActiveObject.restype = ctypes.c_int
RegisterActiveObject.argtypes = [
    ctypes.c_void_p,  # punk : IUnknown*
    ctypes.c_void_p,  # rclsid : GUID*
    wintypes.DWORD,  # dwFlags : ACTIVEOBJECT_FLAGS
    ctypes.POINTER(wintypes.DWORD),  # pdwRegister : DWORD* in/out
]
require 'fiddle'
require 'fiddle/import'

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

var (
	oleaut32 = windows.NewLazySystemDLL("OLEAUT32.dll")
	procRegisterActiveObject = oleaut32.NewProc("RegisterActiveObject")
)

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

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

typedef RegisterActiveObjectNative = Int32 Function(Pointer<Void>, Pointer<Void>, Uint32, Pointer<Uint32>);
typedef RegisterActiveObjectDart = int Function(Pointer<Void>, Pointer<Void>, int, Pointer<Uint32>);
final RegisterActiveObject = DynamicLibrary.open('OLEAUT32.dll')
    .lookupFunction<RegisterActiveObjectNative, RegisterActiveObjectDart>('RegisterActiveObject');
// punk : IUnknown* -> Pointer<Void>
// rclsid : GUID* -> Pointer<Void>
// dwFlags : ACTIVEOBJECT_FLAGS -> Uint32
// pdwRegister : DWORD* in/out -> Pointer<Uint32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function RegisterActiveObject(
  punk: Pointer;   // IUnknown*
  rclsid: PGUID;   // GUID*
  dwFlags: DWORD;   // ACTIVEOBJECT_FLAGS
  pdwRegister: Pointer   // DWORD* in/out
): Integer; stdcall;
  external 'OLEAUT32.dll' name 'RegisterActiveObject';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "RegisterActiveObject"
  c_RegisterActiveObject :: Ptr () -> Ptr () -> Word32 -> Ptr Word32 -> IO Int32
-- punk : IUnknown* -> Ptr ()
-- rclsid : GUID* -> Ptr ()
-- dwFlags : ACTIVEOBJECT_FLAGS -> Word32
-- pdwRegister : DWORD* in/out -> Ptr Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let registeractiveobject =
  foreign "RegisterActiveObject"
    ((ptr void) @-> (ptr void) @-> uint32_t @-> (ptr uint32_t) @-> returning int32_t)
(* punk : IUnknown* -> (ptr void) *)
(* rclsid : GUID* -> (ptr void) *)
(* dwFlags : ACTIVEOBJECT_FLAGS -> uint32_t *)
(* pdwRegister : DWORD* in/out -> (ptr uint32_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library oleaut32 (t "OLEAUT32.dll"))
(cffi:use-foreign-library oleaut32)

(cffi:defcfun ("RegisterActiveObject" register-active-object :convention :stdcall) :int32
  (punk :pointer)   ; IUnknown*
  (rclsid :pointer)   ; GUID*
  (dw-flags :uint32)   ; ACTIVEOBJECT_FLAGS
  (pdw-register :pointer))   ; DWORD* in/out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $RegisterActiveObject = Win32::API::More->new('OLEAUT32',
    'int RegisterActiveObject(LPVOID punk, LPVOID rclsid, DWORD dwFlags, LPVOID pdwRegister)');
# my $ret = $RegisterActiveObject->Call($punk, $rclsid, $dwFlags, $pdwRegister);
# punk : IUnknown* -> LPVOID
# rclsid : GUID* -> LPVOID
# dwFlags : ACTIVEOBJECT_FLAGS -> DWORD
# pdwRegister : DWORD* in/out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目
使用する型