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

CoSetCancelObject

関数
現在の呼び出しに使うキャンセルオブジェクトを設定する。
DLLOLE32.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

HRESULT CoSetCancelObject(
    IUnknown* pUnk   // optional
);

パラメーター

名前方向説明
pUnkIUnknown*inoptional現在のスレッドで設定またはリセットするキャンセルオブジェクトの IUnknown インターフェイスへのポインター。このパラメーターが NULL の場合、最上位のキャンセルオブジェクトがリセットされます。

戻り値の型: HRESULT

公式ドキュメント

現在のスレッドでの後続のキャンセル操作で使用するキャンセルオブジェクトを設定 (登録) またはリセット (登録解除) します。

戻り値

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

戻り値 説明
S_OK
キャンセルオブジェクトが正常に設定またはリセットされました。
E_ACCESSDENIED
キャンセル操作がブロックされているため、現時点ではキャンセルオブジェクトを設定またはリセットできません。

解説(Remarks)

標準マーシャリングをサポートするオブジェクトの場合、プロキシオブジェクトは CoSetCancelObject を呼び出して現在のスレッドのキャンセルオブジェクトを登録することで、メソッド呼び出しのマーシャリングを開始します。

CoSetCancelObject は、キャンセルオブジェクトに対して ICancelMethodCallsQueryInterface を呼び出します。キャンセルオブジェクトが ICancelMethodCalls を実装していない場合、CoSetCancelObjectE_NOINTERFACE で失敗します。カスタムマーシャリングされたインターフェイスでキャンセル操作を無効にするには、ICancelMethodCalls::Cancel の実装が E_NOTIMPLE_FAIL、またはその他の適切な値を返すだけにする必要があります。

CoSetCancelObject は、登録するオブジェクトに対して AddRef を呼び出し、登録解除するオブジェクトに対して Release を呼び出します。

CoSetCancelObject は、非同期メソッドのキャンセルオブジェクトの設定やリセットは行いません。

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

各言語での呼び出し定義

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

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

CoSetCancelObject = ctypes.windll.ole32.CoSetCancelObject
CoSetCancelObject.restype = ctypes.c_int
CoSetCancelObject.argtypes = [
    ctypes.c_void_p,  # pUnk : IUnknown* optional
]
require 'fiddle'
require 'fiddle/import'

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

var (
	ole32 = windows.NewLazySystemDLL("OLE32.dll")
	procCoSetCancelObject = ole32.NewProc("CoSetCancelObject")
)

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

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

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

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

let cosetcancelobject =
  foreign "CoSetCancelObject"
    ((ptr void) @-> returning int32_t)
(* pUnk : IUnknown* 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 ("CoSetCancelObject" co-set-cancel-object :convention :stdcall) :int32
  (p-unk :pointer))   ; IUnknown* optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $CoSetCancelObject = Win32::API::More->new('OLE32',
    'int CoSetCancelObject(LPVOID pUnk)');
# my $ret = $CoSetCancelObject->Call($pUnk);
# pUnk : IUnknown* optional -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目
使用する型