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

CoCancelCall

関数
指定スレッドの未処理COM呼び出しをキャンセルする。
DLLOLE32.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

HRESULT CoCancelCall(
    DWORD dwThreadId,
    DWORD ulTimeout
);

パラメーター

名前方向説明
dwThreadIdDWORDin保留中の DCOM 呼び出しをキャンセルするスレッドの識別子。このパラメーターが 0 の場合、呼び出しは現在のスレッド上にあります。
ulTimeoutDWORDinクライアントがキャンセルを要求した後、サーバーが送信中の呼び出しを完了するのを CoCancelCall が待機する秒数。

戻り値の型: HRESULT

公式ドキュメント

指定したスレッドで保留中の、送信中の DCOM メソッド呼び出しのキャンセルを要求します。

戻り値

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

戻り値 説明
S_OK
キャンセル要求が行われました。
E_NOINTERFACE
指定したスレッドに対応するキャンセル オブジェクトがありません。
CO_E_CANCEL_DISABLED
指定したスレッドで呼び出しのキャンセルが有効になっていません。
RPC_E_CALL_COMPLETE
タイムアウト間隔内に呼び出しが完了しました。
RPC_E_CALL_CANCELED
呼び出しは既にキャンセルされています。

解説(Remarks)

CoCancelCall は、実行中の呼び出しに対するキャンセル オブジェクトに対して CoGetCancelObject を呼び出し、続いて ICancelMethodCalls::Cancel を呼び出します。

この関数は、非同期呼び出しのキャンセル オブジェクトを検索しません。

オブジェクト サーバーは、CoTestCancel を定期的に呼び出すことで、呼び出しがキャンセルされたかどうかを判断できます。呼び出しがキャンセルされた場合、オブジェクト サーバーはクリーンアップを行い、制御をクライアントに返す必要があります。

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

各言語での呼び出し定義

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

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

CoCancelCall = ctypes.windll.ole32.CoCancelCall
CoCancelCall.restype = ctypes.c_int
CoCancelCall.argtypes = [
    wintypes.DWORD,  # dwThreadId : DWORD
    wintypes.DWORD,  # ulTimeout : DWORD
]
require 'fiddle'
require 'fiddle/import'

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

var (
	ole32 = windows.NewLazySystemDLL("OLE32.dll")
	procCoCancelCall = ole32.NewProc("CoCancelCall")
)

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

extern "ole32" fn CoCancelCall(
    dwThreadId: u32, // DWORD
    ulTimeout: u32 // DWORD
) callconv(std.os.windows.WINAPI) i32;
proc CoCancelCall(
    dwThreadId: uint32,  # DWORD
    ulTimeout: uint32  # DWORD
): int32 {.importc: "CoCancelCall", stdcall, dynlib: "OLE32.dll".}
pragma(lib, "ole32");
extern(Windows)
int CoCancelCall(
    uint dwThreadId,   // DWORD
    uint ulTimeout   // DWORD
);
ccall((:CoCancelCall, "OLE32.dll"), stdcall, Int32,
      (UInt32, UInt32),
      dwThreadId, ulTimeout)
# dwThreadId : DWORD -> UInt32
# ulTimeout : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t CoCancelCall(
    uint32_t dwThreadId,
    uint32_t ulTimeout);
]]
local ole32 = ffi.load("ole32")
-- ole32.CoCancelCall(dwThreadId, ulTimeout)
-- dwThreadId : DWORD
-- ulTimeout : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('OLE32.dll');
const CoCancelCall = lib.func('__stdcall', 'CoCancelCall', 'int32_t', ['uint32_t', 'uint32_t']);
// CoCancelCall(dwThreadId, ulTimeout)
// dwThreadId : DWORD -> 'uint32_t'
// ulTimeout : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("OLE32.dll", {
  CoCancelCall: { parameters: ["u32", "u32"], result: "i32" },
});
// lib.symbols.CoCancelCall(dwThreadId, ulTimeout)
// dwThreadId : DWORD -> "u32"
// ulTimeout : DWORD -> "u32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t CoCancelCall(
    uint32_t dwThreadId,
    uint32_t ulTimeout);
C, "OLE32.dll");
// $ffi->CoCancelCall(dwThreadId, ulTimeout);
// dwThreadId : DWORD
// ulTimeout : 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 CoCancelCall(
        int dwThreadId,   // DWORD
        int ulTimeout   // DWORD
    );
}
@[Link("ole32")]
lib LibOLE32
  fun CoCancelCall = CoCancelCall(
    dwThreadId : UInt32,   # DWORD
    ulTimeout : 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 CoCancelCallNative = Int32 Function(Uint32, Uint32);
typedef CoCancelCallDart = int Function(int, int);
final CoCancelCall = DynamicLibrary.open('OLE32.dll')
    .lookupFunction<CoCancelCallNative, CoCancelCallDart>('CoCancelCall');
// dwThreadId : DWORD -> Uint32
// ulTimeout : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function CoCancelCall(
  dwThreadId: DWORD;   // DWORD
  ulTimeout: DWORD   // DWORD
): Integer; stdcall;
  external 'OLE32.dll' name 'CoCancelCall';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

let cocancelcall =
  foreign "CoCancelCall"
    (uint32_t @-> uint32_t @-> returning int32_t)
(* dwThreadId : DWORD -> uint32_t *)
(* ulTimeout : 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 ("CoCancelCall" co-cancel-call :convention :stdcall) :int32
  (dw-thread-id :uint32)   ; DWORD
  (ul-timeout :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $CoCancelCall = Win32::API::More->new('OLE32',
    'int CoCancelCall(DWORD dwThreadId, DWORD ulTimeout)');
# my $ret = $CoCancelCall->Call($dwThreadId, $ulTimeout);
# dwThreadId : DWORD -> DWORD
# ulTimeout : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目