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

CoDisableCallCancellation

関数
現在のスレッドで同期呼び出しのキャンセルを無効化する。
DLLOLE32.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

HRESULT CoDisableCallCancellation(
    void* pReserved   // optional
);

パラメーター

名前方向説明
pReservedvoid*inoptionalこのパラメーターは予約済みであり、NULL を指定する必要があります。

戻り値の型: HRESULT

公式ドキュメント

CoEnableCallCancellation の呼び出しによる動作を取り消します。CoEnableCallCancellation へのすべての呼び出しが CoDisableCallCancellation への呼び出しで均衡したとき、呼び出し元スレッドにおける同期呼び出しのキャンセルを無効にします。

戻り値

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

戻り値 説明
S_OK
スレッドでの呼び出しのキャンセルが正常に無効化されました。
CO_E_CANCEL_DISABLED
スレッドにおいて、CoDisableCallCancellation の呼び出し回数よりも CoEnableCallCancellation の成功した呼び出し回数の方が多くなっています。スレッドでのキャンセルはまだ有効です。

解説(Remarks)

スレッドで呼び出しのキャンセルが有効になっていると、そのスレッドから同一コンピューター上のオブジェクトへのマーシャリングされた同期呼び出しで、深刻なパフォーマンス低下が生じることがあります。そのため既定では、キャンセル用オブジェクトが利用可能であっても、同期呼び出しはキャンセルできません。呼び出しのキャンセルを有効にするには、最初に CoEnableCallCancellation を呼び出す必要があります。

呼び出しのキャンセルが無効になっている場合、呼び出しオブジェクトへのポインターの取得は失敗します。呼び出し元スレッドが既に呼び出しオブジェクトへのポインターを保持している場合、そのオブジェクトに対する呼び出しは失敗します。

スレッドで呼び出しのキャンセルを常時有効にしておきたい場合を除き、CoEnableCallCancellation の呼び出しは CoDisableCallCancellation の呼び出しと対にする必要があります。CoEnableCallCancellation への各成功呼び出しが CoDisableCallCancellation への成功呼び出しで均衡した場合にのみ、呼び出しのキャンセルが無効化されます。

呼び出しがキャンセル可能かどうかは、その呼び出しが行われた時点のスレッドの状態によって決まります。その後に呼び出しのキャンセルを有効化または無効化しても、スレッドで保留中の呼び出しには影響しません。

スレッドが CoUninitialize および CoInitialize の呼び出しによって初期化解除され、その後再初期化された場合、スレッドの初期化解除時にキャンセルが有効であったとしても、そのスレッドでの呼び出しのキャンセルは無効になります。

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

各言語での呼び出し定義

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

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

CoDisableCallCancellation = ctypes.windll.ole32.CoDisableCallCancellation
CoDisableCallCancellation.restype = ctypes.c_int
CoDisableCallCancellation.argtypes = [
    ctypes.POINTER(None),  # pReserved : void* optional
]
require 'fiddle'
require 'fiddle/import'

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

var (
	ole32 = windows.NewLazySystemDLL("OLE32.dll")
	procCoDisableCallCancellation = ole32.NewProc("CoDisableCallCancellation")
)

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

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

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

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

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

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

関連項目

公式の関連項目