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

CoSuspendClassObjects

関数
クラスオブジェクトへの新規接続要求を一時停止する。
DLLOLE32.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

HRESULT CoSuspendClassObjects(void);

パラメーターなし。戻り値: HRESULT

公式ドキュメント

プロセス内に登録されているすべてのクラスオブジェクトに対して、SCM からの新規アクティベーション要求を抑止します。

戻り値

この関数は、クラスオブジェクトのアクティベーションが正常に中断されたことを示すために S_OK を返します。

解説(Remarks)

CoSuspendClassObjects は、プロセス内に登録されているすべてのクラスオブジェクトに対して、SCM からの新規アクティベーション要求を抑止します。プロセスがこの関数を呼び出した場合でも、登録した各 CLSID について、登録を行ったアパートメント内で CoRevokeClassObject 関数を呼び出す必要があります。通常、アプリケーションがこの関数を呼び出す必要はなく、一般には CoReleaseServerProcess 関数と組み合わせて使用される際に 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 CoSuspendClassObjects(void);
[DllImport("OLE32.dll", ExactSpelling = true)]
static extern int CoSuspendClassObjects();
<DllImport("OLE32.dll", ExactSpelling:=True)>
Public Shared Function CoSuspendClassObjects() As Integer
End Function
Declare PtrSafe Function CoSuspendClassObjects Lib "ole32" () As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

CoSuspendClassObjects = ctypes.windll.ole32.CoSuspendClassObjects
CoSuspendClassObjects.restype = ctypes.c_int
CoSuspendClassObjects.argtypes = []
require 'fiddle'
require 'fiddle/import'

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

var (
	ole32 = windows.NewLazySystemDLL("OLE32.dll")
	procCoSuspendClassObjects = ole32.NewProc("CoSuspendClassObjects")
)

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

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

typedef CoSuspendClassObjectsNative = Int32 Function();
typedef CoSuspendClassObjectsDart = int Function();
final CoSuspendClassObjects = DynamicLibrary.open('OLE32.dll')
    .lookupFunction<CoSuspendClassObjectsNative, CoSuspendClassObjectsDart>('CoSuspendClassObjects');
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function CoSuspendClassObjects: Integer; stdcall;
  external 'OLE32.dll' name 'CoSuspendClassObjects';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

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

(cffi:defcfun ("CoSuspendClassObjects" co-suspend-class-objects :convention :stdcall) :int32)
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $CoSuspendClassObjects = Win32::API::More->new('OLE32',
    'int CoSuspendClassObjects()');
# my $ret = $CoSuspendClassObjects->Call();
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目