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

MFCancelCreateFile

関数
進行中の非同期ファイル生成操作をキャンセルする。
DLLMFPlat.dll呼出規約winapi対応OSWindows Vista 以降

シグネチャ

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

HRESULT MFCancelCreateFile(
    IUnknown* pCancelCookie
);

パラメーター

名前方向説明
pCancelCookieIUnknown*inキャンセルオブジェクトの IUnknown インターフェイスへのポインター。このポインターは、MFBeginCreateFile 関数の ppCancelCookie パラメーターで受け取ります。

戻り値の型: HRESULT

公式ドキュメント

ファイルからバイトストリームを作成する非同期要求をキャンセルします。

戻り値

この関数は HRESULT を返します。指定できる値には、次の表に示す値が含まれますが、これらに限定されません。

戻り値 説明
S_OK
関数は成功しました。

解説(Remarks)

この関数を使用して、MFBeginCreateFile への以前の呼び出しをキャンセルできます。ただし、この関数は非同期であるため、操作をキャンセルする前に完了する場合があります。そのため、この関数を呼び出した後でもコールバックが呼び出される可能性があります。

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

各言語での呼び出し定義

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

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

MFCancelCreateFile = ctypes.windll.mfplat.MFCancelCreateFile
MFCancelCreateFile.restype = ctypes.c_int
MFCancelCreateFile.argtypes = [
    ctypes.c_void_p,  # pCancelCookie : IUnknown*
]
require 'fiddle'
require 'fiddle/import'

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

var (
	mfplat = windows.NewLazySystemDLL("MFPlat.dll")
	procMFCancelCreateFile = mfplat.NewProc("MFCancelCreateFile")
)

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

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

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

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

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

(cffi:defcfun ("MFCancelCreateFile" mfcancel-create-file :convention :stdcall) :int32
  (p-cancel-cookie :pointer))   ; IUnknown*
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $MFCancelCreateFile = Win32::API::More->new('MFPlat',
    'int MFCancelCreateFile(LPVOID pCancelCookie)');
# my $ret = $MFCancelCreateFile->Call($pCancelCookie);
# pCancelCookie : IUnknown* -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型