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

MFScheduleWorkItem

関数
指定時間後に実行する非同期作業項目をスケジュールする。
DLLMFPlat.dll呼出規約winapi対応OSWindows Vista 以降

シグネチャ

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

HRESULT MFScheduleWorkItem(
    IMFAsyncCallback* pCallback,
    IUnknown* pState,
    LONGLONG Timeout,
    ULONGLONG* pKey   // optional
);

パラメーター

名前方向説明
pCallbackIMFAsyncCallback*inIMFAsyncCallback インターフェイスへのポインター。呼び出し側がこのインターフェイスを実装する必要があります。
pStateIUnknown*in呼び出し側が定義する状態オブジェクトの IUnknown インターフェイスへのポインター。このパラメーターは NULL でもかまいません。このオブジェクトを使用して状態情報を保持できます。コールバックが呼び出されると、オブジェクトが呼び出し側に返されます。
TimeoutLONGLONGinタイムアウト間隔(ミリ秒単位)。このパラメーターには負の値を設定します。コールバックは −Timeout ミリ秒後に呼び出されます。たとえば、Timeout が −5000 の場合、コールバックは 5000 ミリ秒後に呼び出されます。
pKeyULONGLONG*outoptionalタイマーのキャンセルに使用できるキーを受け取ります。タイマーをキャンセルするには、MFCancelWorkItem を呼び出し、このキーを Key パラメーターに渡します。

戻り値の型: HRESULT

公式ドキュメント

指定した間隔の経過後に完了する非同期操作をスケジュールします。(MFScheduleWorkItem)

戻り値

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

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

解説(Remarks)

この関数は非同期結果オブジェクトを作成します。タイマー間隔が経過すると、pCallback で指定された IMFAsyncCallback::Invoke メソッドが呼び出されます。

この関数は、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 MFScheduleWorkItem(
    IMFAsyncCallback* pCallback,
    IUnknown* pState,
    LONGLONG Timeout,
    ULONGLONG* pKey   // optional
);
[DllImport("MFPlat.dll", ExactSpelling = true)]
static extern int MFScheduleWorkItem(
    IntPtr pCallback,   // IMFAsyncCallback*
    IntPtr pState,   // IUnknown*
    long Timeout,   // LONGLONG
    IntPtr pKey   // ULONGLONG* optional, out
);
<DllImport("MFPlat.dll", ExactSpelling:=True)>
Public Shared Function MFScheduleWorkItem(
    pCallback As IntPtr,   ' IMFAsyncCallback*
    pState As IntPtr,   ' IUnknown*
    Timeout As Long,   ' LONGLONG
    pKey As IntPtr   ' ULONGLONG* optional, out
) As Integer
End Function
' pCallback : IMFAsyncCallback*
' pState : IUnknown*
' Timeout : LONGLONG
' pKey : ULONGLONG* optional, out
Declare PtrSafe Function MFScheduleWorkItem Lib "mfplat" ( _
    ByVal pCallback As LongPtr, _
    ByVal pState As LongPtr, _
    ByVal Timeout As LongLong, _
    ByVal pKey As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

MFScheduleWorkItem = ctypes.windll.mfplat.MFScheduleWorkItem
MFScheduleWorkItem.restype = ctypes.c_int
MFScheduleWorkItem.argtypes = [
    ctypes.c_void_p,  # pCallback : IMFAsyncCallback*
    ctypes.c_void_p,  # pState : IUnknown*
    ctypes.c_longlong,  # Timeout : LONGLONG
    ctypes.POINTER(ctypes.c_ulonglong),  # pKey : ULONGLONG* optional, out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('MFPlat.dll')
MFScheduleWorkItem = Fiddle::Function.new(
  lib['MFScheduleWorkItem'],
  [
    Fiddle::TYPE_VOIDP,  # pCallback : IMFAsyncCallback*
    Fiddle::TYPE_VOIDP,  # pState : IUnknown*
    Fiddle::TYPE_LONG_LONG,  # Timeout : LONGLONG
    Fiddle::TYPE_VOIDP,  # pKey : ULONGLONG* optional, out
  ],
  Fiddle::TYPE_INT)
#[link(name = "mfplat")]
extern "system" {
    fn MFScheduleWorkItem(
        pCallback: *mut core::ffi::c_void,  // IMFAsyncCallback*
        pState: *mut core::ffi::c_void,  // IUnknown*
        Timeout: i64,  // LONGLONG
        pKey: *mut u64  // ULONGLONG* optional, out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("MFPlat.dll")]
public static extern int MFScheduleWorkItem(IntPtr pCallback, IntPtr pState, long Timeout, IntPtr pKey);
"@
$api = Add-Type -MemberDefinition $sig -Name 'MFPlat_MFScheduleWorkItem' -Namespace Win32 -PassThru
# $api::MFScheduleWorkItem(pCallback, pState, Timeout, pKey)
#uselib "MFPlat.dll"
#func global MFScheduleWorkItem "MFScheduleWorkItem" sptr, sptr, sptr, sptr
; MFScheduleWorkItem pCallback, pState, Timeout, varptr(pKey)   ; 戻り値は stat
; pCallback : IMFAsyncCallback* -> "sptr"
; pState : IUnknown* -> "sptr"
; Timeout : LONGLONG -> "sptr"
; pKey : ULONGLONG* optional, out -> "sptr"
; ※HSP3.7は int64 引数(64bit値渡し)に非対応です。
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "MFPlat.dll"
#cfunc global MFScheduleWorkItem "MFScheduleWorkItem" sptr, sptr, int64, var
; res = MFScheduleWorkItem(pCallback, pState, Timeout, pKey)
; pCallback : IMFAsyncCallback* -> "sptr"
; pState : IUnknown* -> "sptr"
; Timeout : LONGLONG -> "int64"
; pKey : ULONGLONG* optional, out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
; ※int64 引数の DLL 値渡しは x64 ランタイム(hsp3_64)のみ対応(x86 は未対応)。
出力引数:
; HRESULT MFScheduleWorkItem(IMFAsyncCallback* pCallback, IUnknown* pState, LONGLONG Timeout, ULONGLONG* pKey)
#uselib "MFPlat.dll"
#cfunc global MFScheduleWorkItem "MFScheduleWorkItem" intptr, intptr, int64, var
; res = MFScheduleWorkItem(pCallback, pState, Timeout, pKey)
; pCallback : IMFAsyncCallback* -> "intptr"
; pState : IUnknown* -> "intptr"
; Timeout : LONGLONG -> "int64"
; pKey : ULONGLONG* optional, out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	mfplat = windows.NewLazySystemDLL("MFPlat.dll")
	procMFScheduleWorkItem = mfplat.NewProc("MFScheduleWorkItem")
)

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

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

typedef MFScheduleWorkItemNative = Int32 Function(Pointer<Void>, Pointer<Void>, Int64, Pointer<Uint64>);
typedef MFScheduleWorkItemDart = int Function(Pointer<Void>, Pointer<Void>, int, Pointer<Uint64>);
final MFScheduleWorkItem = DynamicLibrary.open('MFPlat.dll')
    .lookupFunction<MFScheduleWorkItemNative, MFScheduleWorkItemDart>('MFScheduleWorkItem');
// pCallback : IMFAsyncCallback* -> Pointer<Void>
// pState : IUnknown* -> Pointer<Void>
// Timeout : LONGLONG -> Int64
// pKey : ULONGLONG* optional, out -> Pointer<Uint64>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function MFScheduleWorkItem(
  pCallback: Pointer;   // IMFAsyncCallback*
  pState: Pointer;   // IUnknown*
  Timeout: Int64;   // LONGLONG
  pKey: Pointer   // ULONGLONG* optional, out
): Integer; stdcall;
  external 'MFPlat.dll' name 'MFScheduleWorkItem';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "MFScheduleWorkItem"
  c_MFScheduleWorkItem :: Ptr () -> Ptr () -> Int64 -> Ptr Word64 -> IO Int32
-- pCallback : IMFAsyncCallback* -> Ptr ()
-- pState : IUnknown* -> Ptr ()
-- Timeout : LONGLONG -> Int64
-- pKey : ULONGLONG* optional, out -> Ptr Word64
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let mfscheduleworkitem =
  foreign "MFScheduleWorkItem"
    ((ptr void) @-> (ptr void) @-> int64_t @-> (ptr uint64_t) @-> returning int32_t)
(* pCallback : IMFAsyncCallback* -> (ptr void) *)
(* pState : IUnknown* -> (ptr void) *)
(* Timeout : LONGLONG -> int64_t *)
(* pKey : ULONGLONG* optional, out -> (ptr uint64_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library mfplat (t "MFPlat.dll"))
(cffi:use-foreign-library mfplat)

(cffi:defcfun ("MFScheduleWorkItem" mfschedule-work-item :convention :stdcall) :int32
  (p-callback :pointer)   ; IMFAsyncCallback*
  (p-state :pointer)   ; IUnknown*
  (timeout :int64)   ; LONGLONG
  (p-key :pointer))   ; ULONGLONG* optional, out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $MFScheduleWorkItem = Win32::API::More->new('MFPlat',
    'int MFScheduleWorkItem(LPVOID pCallback, LPVOID pState, INT64 Timeout, LPVOID pKey)');
# my $ret = $MFScheduleWorkItem->Call($pCallback, $pState, $Timeout, $pKey);
# pCallback : IMFAsyncCallback* -> LPVOID
# pState : IUnknown* -> LPVOID
# Timeout : LONGLONG -> INT64
# pKey : ULONGLONG* optional, out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

類似 API
使用する型