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

CoGetCancelObject

関数
指定スレッドの呼び出しに対するキャンセルオブジェクトを取得する。
DLLOLE32.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

HRESULT CoGetCancelObject(
    DWORD dwThreadId,
    const GUID* iid,
    void** ppUnk
);

パラメーター

名前方向説明
dwThreadIdDWORDin保留中の COM 呼び出しをキャンセルする対象のスレッドの識別子です。このパラメーターが 0 の場合、呼び出しは現在のスレッド上にあります。
iidGUID*inキャンセルする呼び出しのキャンセルオブジェクト上のインターフェイスを表すグローバル一意識別子です。この引数は通常 IID_ICancelMethodCalls です。
ppUnkvoid**outriid で指定されたインターフェイスへのポインターのアドレスを受け取ります。

戻り値の型: HRESULT

公式ドキュメント

同一または別のクライアントスレッドで保留中の送信 COM メソッド呼び出しに対応するキャンセルオブジェクト上の、通常は ICancelMethodCalls である呼び出し制御インターフェイスへのポインターを取得します。

戻り値

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

戻り値 説明
S_OK
呼び出し制御オブジェクトが正常に取得されました。
E_NOINTERFACE
呼び出しが実行されているオブジェクトが、riid で指定されたインターフェイスをサポートしていません。

解説(Remarks)

ネストされた呼び出しによって同一スレッド上で 2 つ以上の呼び出しが保留中の場合、スレッド ID だけではキャンセル対象の呼び出しを特定するのに十分でないことがあります。この場合、CoGetCancelObject は、そのスレッド上で保留中かつキャンセルオブジェクトを登録している最も内側の呼び出しに対応するキャンセルインターフェイスを返します。

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

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

各言語での呼び出し定義

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

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

CoGetCancelObject = ctypes.windll.ole32.CoGetCancelObject
CoGetCancelObject.restype = ctypes.c_int
CoGetCancelObject.argtypes = [
    wintypes.DWORD,  # dwThreadId : DWORD
    ctypes.c_void_p,  # iid : GUID*
    ctypes.c_void_p,  # ppUnk : void** out
]
require 'fiddle'
require 'fiddle/import'

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

var (
	ole32 = windows.NewLazySystemDLL("OLE32.dll")
	procCoGetCancelObject = ole32.NewProc("CoGetCancelObject")
)

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

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

typedef CoGetCancelObjectNative = Int32 Function(Uint32, Pointer<Void>, Pointer<Void>);
typedef CoGetCancelObjectDart = int Function(int, Pointer<Void>, Pointer<Void>);
final CoGetCancelObject = DynamicLibrary.open('OLE32.dll')
    .lookupFunction<CoGetCancelObjectNative, CoGetCancelObjectDart>('CoGetCancelObject');
// dwThreadId : DWORD -> Uint32
// iid : GUID* -> Pointer<Void>
// ppUnk : void** out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function CoGetCancelObject(
  dwThreadId: DWORD;   // DWORD
  iid: PGUID;   // GUID*
  ppUnk: Pointer   // void** out
): Integer; stdcall;
  external 'OLE32.dll' name 'CoGetCancelObject';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "CoGetCancelObject"
  c_CoGetCancelObject :: Word32 -> Ptr () -> Ptr () -> IO Int32
-- dwThreadId : DWORD -> Word32
-- iid : GUID* -> Ptr ()
-- ppUnk : void** out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

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

(cffi:defcfun ("CoGetCancelObject" co-get-cancel-object :convention :stdcall) :int32
  (dw-thread-id :uint32)   ; DWORD
  (iid :pointer)   ; GUID*
  (pp-unk :pointer))   ; void** out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $CoGetCancelObject = Win32::API::More->new('OLE32',
    'int CoGetCancelObject(DWORD dwThreadId, LPVOID iid, LPVOID ppUnk)');
# my $ret = $CoGetCancelObject->Call($dwThreadId, $iid, $ppUnk);
# dwThreadId : DWORD -> DWORD
# iid : GUID* -> LPVOID
# ppUnk : void** out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。