Win32 API 日本語リファレンス
ホームMedia.MediaFoundation › MFCancelWorkItem

MFCancelWorkItem

関数
スケジュール済みの作業項目をキーで指定してキャンセルする。
DLLMFPlat.dll呼出規約winapi対応OSWindows Vista 以降

シグネチャ

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

HRESULT MFCancelWorkItem(
    ULONGLONG Key
);

パラメーター

名前方向説明
KeyULONGLONGinMFScheduleWorkItemMFScheduleWorkItemEx、または MFPutWaitingWorkItem 関数の pKey パラメーターで受け取ったキー。

戻り値の型: HRESULT

公式ドキュメント

MFScheduleWorkItem または MFScheduleWorkItemEx でスケジュールされた非同期操作のキャンセルを試みます。

戻り値

この関数が成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

解説(Remarks)

作業項目は非同期であるため、MFCancelWorkItem の呼び出し後でも作業項目のコールバックが呼び出される場合があります。

この関数は、Windows Media Format 11 SDK 再頒布可能コンポーネントがインストールされている場合、次のプラットフォームで利用できます。

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

各言語での呼び出し定義

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

HRESULT MFCancelWorkItem(
    ULONGLONG Key
);
[DllImport("MFPlat.dll", ExactSpelling = true)]
static extern int MFCancelWorkItem(
    ulong Key   // ULONGLONG
);
<DllImport("MFPlat.dll", ExactSpelling:=True)>
Public Shared Function MFCancelWorkItem(
    Key As ULong   ' ULONGLONG
) As Integer
End Function
' Key : ULONGLONG
Declare PtrSafe Function MFCancelWorkItem Lib "mfplat" ( _
    ByVal Key As LongLong) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

MFCancelWorkItem = ctypes.windll.mfplat.MFCancelWorkItem
MFCancelWorkItem.restype = ctypes.c_int
MFCancelWorkItem.argtypes = [
    ctypes.c_ulonglong,  # Key : ULONGLONG
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('MFPlat.dll')
MFCancelWorkItem = Fiddle::Function.new(
  lib['MFCancelWorkItem'],
  [
    -Fiddle::TYPE_LONG_LONG,  # Key : ULONGLONG
  ],
  Fiddle::TYPE_INT)
#[link(name = "mfplat")]
extern "system" {
    fn MFCancelWorkItem(
        Key: u64  // ULONGLONG
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("MFPlat.dll")]
public static extern int MFCancelWorkItem(ulong Key);
"@
$api = Add-Type -MemberDefinition $sig -Name 'MFPlat_MFCancelWorkItem' -Namespace Win32 -PassThru
# $api::MFCancelWorkItem(Key)
#uselib "MFPlat.dll"
#func global MFCancelWorkItem "MFCancelWorkItem" sptr
; MFCancelWorkItem Key   ; 戻り値は stat
; Key : ULONGLONG -> "sptr"
; ※HSP3.7は int64 引数(64bit値渡し)に非対応です。
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "MFPlat.dll"
#cfunc global MFCancelWorkItem "MFCancelWorkItem" int64
; res = MFCancelWorkItem(Key)
; Key : ULONGLONG -> "int64"
; ※int64 引数の DLL 値渡しは x64 ランタイム(hsp3_64)のみ対応(x86 は未対応)。
; HRESULT MFCancelWorkItem(ULONGLONG Key)
#uselib "MFPlat.dll"
#cfunc global MFCancelWorkItem "MFCancelWorkItem" int64
; res = MFCancelWorkItem(Key)
; Key : ULONGLONG -> "int64"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	mfplat = windows.NewLazySystemDLL("MFPlat.dll")
	procMFCancelWorkItem = mfplat.NewProc("MFCancelWorkItem")
)

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

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

typedef MFCancelWorkItemNative = Int32 Function(Uint64);
typedef MFCancelWorkItemDart = int Function(int);
final MFCancelWorkItem = DynamicLibrary.open('MFPlat.dll')
    .lookupFunction<MFCancelWorkItemNative, MFCancelWorkItemDart>('MFCancelWorkItem');
// Key : ULONGLONG -> Uint64
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function MFCancelWorkItem(
  Key: UInt64   // ULONGLONG
): Integer; stdcall;
  external 'MFPlat.dll' name 'MFCancelWorkItem';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

let mfcancelworkitem =
  foreign "MFCancelWorkItem"
    (uint64_t @-> returning int32_t)
(* Key : ULONGLONG -> uint64_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library mfplat (t "MFPlat.dll"))
(cffi:use-foreign-library mfplat)

(cffi:defcfun ("MFCancelWorkItem" mfcancel-work-item :convention :stdcall) :int32
  (key :uint64))   ; ULONGLONG
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $MFCancelWorkItem = Win32::API::More->new('MFPlat',
    'int MFCancelWorkItem(UINT64 Key)');
# my $ret = $MFCancelWorkItem->Call($Key);
# Key : ULONGLONG -> UINT64
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。