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

CoDisconnectObject

関数
オブジェクトへの全リモートプロキシ接続を切断する。
DLLOLE32.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

HRESULT CoDisconnectObject(
    IUnknown* pUnk,
    DWORD dwReserved
);

パラメーター

名前方向説明
pUnkIUnknown*in切断するオブジェクト上の、IUnknown から派生した任意のインターフェイスへのポインター。
dwReservedDWORDinこのパラメーターは予約されており、0 を指定する必要があります。

戻り値の型: HRESULT

公式ドキュメント

指定したオブジェクトを指すすべてのインターフェイスポインターのために維持されている、リモートプロセスとのすべての接続を切断します。

戻り値

この関数は、リモートプロセスへのすべての接続が正常に削除されたことを示すために S_OK を返します。

解説(Remarks)

CoDisconnectObject 関数を使用すると、サーバーは pUnk で指定されたオブジェクトに接続しているすべての外部クライアントを正しく切断できます。

この関数は次の処理を実行します。

  1. 切断するオブジェクトが IMarshal インターフェイスを実装しているかどうかを確認します。実装している場合はそのインターフェイスへのポインターを取得し、実装していない場合は標準マーシャラー(すなわち COM)の IMarshal 実装へのポインターを取得します。
  2. 取得した IMarshal インターフェイスポインターを使用して、IMarshal::DisconnectObject を呼び出し、すべてのプロセス外クライアントを切断します。
オブジェクトのクライアントは、サーバーから自身を切断するために CoDisconnectObject を呼び出すことはありません(クライアントはこの目的には IUnknown::Release を使用します)。むしろ、OLE サーバーがオブジェクトのクライアントを強制的に切断するために CoDisconnectObject を呼び出します。これは通常、ユーザーがサーバーアプリケーションを閉じたときに行われます。

同様に、埋め込みオブジェクトへの外部リンクをサポートする OLE コンテナーは、それらのリンクを破棄するために CoDisconnectObject を呼び出すことができます。この場合も、この呼び出しは通常、ユーザーがアプリケーションを閉じたときに行われます。コンテナーは、まずすべての OLE オブジェクトに対して IOleObject::Close を呼び出す必要があります。各オブジェクトは、それぞれのクライアントに IAdviseSink::OnClose 通知を送信する必要があります。その後、コンテナーは CoDisconnectObject を呼び出して、既存の接続をすべて閉じることができます。

CoDisconnectObject は、必ずしもプロセス外クライアントを即座に切断するわけではありません。サーバーオブジェクトに対してマーシャリングされた呼び出しが保留中の場合、CoDisconnectObject はそれらの呼び出しが戻った後にのみオブジェクトを切断します。それまでの間、CoDisconnectObject は、新しくマーシャリングされた呼び出しが CO_E_OBJNOTCONNECTED を返すようにするフラグを設定します。

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

各言語での呼び出し定義

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

HRESULT CoDisconnectObject(
    IUnknown* pUnk,
    DWORD dwReserved
);
[DllImport("OLE32.dll", ExactSpelling = true)]
static extern int CoDisconnectObject(
    IntPtr pUnk,   // IUnknown*
    uint dwReserved   // DWORD
);
<DllImport("OLE32.dll", ExactSpelling:=True)>
Public Shared Function CoDisconnectObject(
    pUnk As IntPtr,   ' IUnknown*
    dwReserved As UInteger   ' DWORD
) As Integer
End Function
' pUnk : IUnknown*
' dwReserved : DWORD
Declare PtrSafe Function CoDisconnectObject Lib "ole32" ( _
    ByVal pUnk As LongPtr, _
    ByVal dwReserved As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

CoDisconnectObject = ctypes.windll.ole32.CoDisconnectObject
CoDisconnectObject.restype = ctypes.c_int
CoDisconnectObject.argtypes = [
    ctypes.c_void_p,  # pUnk : IUnknown*
    wintypes.DWORD,  # dwReserved : DWORD
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('OLE32.dll')
CoDisconnectObject = Fiddle::Function.new(
  lib['CoDisconnectObject'],
  [
    Fiddle::TYPE_VOIDP,  # pUnk : IUnknown*
    -Fiddle::TYPE_INT,  # dwReserved : DWORD
  ],
  Fiddle::TYPE_INT)
#[link(name = "ole32")]
extern "system" {
    fn CoDisconnectObject(
        pUnk: *mut core::ffi::c_void,  // IUnknown*
        dwReserved: u32  // DWORD
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("OLE32.dll")]
public static extern int CoDisconnectObject(IntPtr pUnk, uint dwReserved);
"@
$api = Add-Type -MemberDefinition $sig -Name 'OLE32_CoDisconnectObject' -Namespace Win32 -PassThru
# $api::CoDisconnectObject(pUnk, dwReserved)
#uselib "OLE32.dll"
#func global CoDisconnectObject "CoDisconnectObject" sptr, sptr
; CoDisconnectObject pUnk, dwReserved   ; 戻り値は stat
; pUnk : IUnknown* -> "sptr"
; dwReserved : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "OLE32.dll"
#cfunc global CoDisconnectObject "CoDisconnectObject" sptr, int
; res = CoDisconnectObject(pUnk, dwReserved)
; pUnk : IUnknown* -> "sptr"
; dwReserved : DWORD -> "int"
; HRESULT CoDisconnectObject(IUnknown* pUnk, DWORD dwReserved)
#uselib "OLE32.dll"
#cfunc global CoDisconnectObject "CoDisconnectObject" intptr, int
; res = CoDisconnectObject(pUnk, dwReserved)
; pUnk : IUnknown* -> "intptr"
; dwReserved : DWORD -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	ole32 = windows.NewLazySystemDLL("OLE32.dll")
	procCoDisconnectObject = ole32.NewProc("CoDisconnectObject")
)

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

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

typedef CoDisconnectObjectNative = Int32 Function(Pointer<Void>, Uint32);
typedef CoDisconnectObjectDart = int Function(Pointer<Void>, int);
final CoDisconnectObject = DynamicLibrary.open('OLE32.dll')
    .lookupFunction<CoDisconnectObjectNative, CoDisconnectObjectDart>('CoDisconnectObject');
// pUnk : IUnknown* -> Pointer<Void>
// dwReserved : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function CoDisconnectObject(
  pUnk: Pointer;   // IUnknown*
  dwReserved: DWORD   // DWORD
): Integer; stdcall;
  external 'OLE32.dll' name 'CoDisconnectObject';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "CoDisconnectObject"
  c_CoDisconnectObject :: Ptr () -> Word32 -> IO Int32
-- pUnk : IUnknown* -> Ptr ()
-- dwReserved : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let codisconnectobject =
  foreign "CoDisconnectObject"
    ((ptr void) @-> uint32_t @-> returning int32_t)
(* pUnk : IUnknown* -> (ptr void) *)
(* dwReserved : DWORD -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library ole32 (t "OLE32.dll"))
(cffi:use-foreign-library ole32)

(cffi:defcfun ("CoDisconnectObject" co-disconnect-object :convention :stdcall) :int32
  (p-unk :pointer)   ; IUnknown*
  (dw-reserved :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $CoDisconnectObject = Win32::API::More->new('OLE32',
    'int CoDisconnectObject(LPVOID pUnk, DWORD dwReserved)');
# my $ret = $CoDisconnectObject->Call($pUnk, $dwReserved);
# pUnk : IUnknown* -> LPVOID
# dwReserved : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型