ホーム › Media.MediaFoundation › MFScheduleWorkItemEx

MFScheduleWorkItemEx

関数

指定タイムアウト後に実行する作業項目をスケジュールする。

DLLMFPlat.dll呼出規約winapi対応OSWindows Vista 以降

シグネチャ

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

HRESULT MFScheduleWorkItemEx(
    IMFAsyncResult* pResult,
    LONGLONG Timeout,
    ULONGLONG* pKey   // optional
);

パラメーター

名前	型	方向	説明
pResult	IMFAsyncResult*	in	非同期結果オブジェクトの IMFAsyncResult インターフェイスへのポインター。結果オブジェクトを作成するには、MFCreateAsyncResult を呼び出します。
Timeout	LONGLONG	in	タイムアウト間隔(ミリ秒単位)。このパラメーターには負の値を設定します。コールバックは −Timeout ミリ秒後に呼び出されます。たとえば、Timeout が −5000 の場合、コールバックは 5000 ミリ秒後に呼び出されます。
pKey	ULONGLONG*	outoptional	タイマーをキャンセルするために使用できるキーを受け取ります。タイマーをキャンセルするには、MFCancelWorkItem を呼び出し、このキーを Key パラメーターに渡します。

戻り値の型: HRESULT

公式ドキュメント

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

戻り値

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

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

解説(Remarks)

タイマー間隔が経過すると、タイマーは pResult ポインターを指定して MFInvokeCallback を呼び出し、非同期コールバックを起動します。このコールバックは、結果オブジェクトを作成するときに指定します。

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

各言語での呼び出し定義

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

HRESULT MFScheduleWorkItemEx(
    IMFAsyncResult* pResult,
    LONGLONG Timeout,
    ULONGLONG* pKey   // optional
);

[DllImport("MFPlat.dll", ExactSpelling = true)]
static extern int MFScheduleWorkItemEx(
    IntPtr pResult,   // IMFAsyncResult*
    long Timeout,   // LONGLONG
    IntPtr pKey   // ULONGLONG* optional, out
);

<DllImport("MFPlat.dll", ExactSpelling:=True)>
Public Shared Function MFScheduleWorkItemEx(
    pResult As IntPtr,   ' IMFAsyncResult*
    Timeout As Long,   ' LONGLONG
    pKey As IntPtr   ' ULONGLONG* optional, out
) As Integer
End Function

' pResult : IMFAsyncResult*
' Timeout : LONGLONG
' pKey : ULONGLONG* optional, out
Declare PtrSafe Function MFScheduleWorkItemEx Lib "mfplat" ( _
    ByVal pResult 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

MFScheduleWorkItemEx = ctypes.windll.mfplat.MFScheduleWorkItemEx
MFScheduleWorkItemEx.restype = ctypes.c_int
MFScheduleWorkItemEx.argtypes = [
    ctypes.c_void_p,  # pResult : IMFAsyncResult*
    ctypes.c_longlong,  # Timeout : LONGLONG
    ctypes.POINTER(ctypes.c_ulonglong),  # pKey : ULONGLONG* optional, out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('MFPlat.dll')
MFScheduleWorkItemEx = Fiddle::Function.new(
  lib['MFScheduleWorkItemEx'],
  [
    Fiddle::TYPE_VOIDP,  # pResult : IMFAsyncResult*
    Fiddle::TYPE_LONG_LONG,  # Timeout : LONGLONG
    Fiddle::TYPE_VOIDP,  # pKey : ULONGLONG* optional, out
  ],
  Fiddle::TYPE_INT)

#[link(name = "mfplat")]
extern "system" {
    fn MFScheduleWorkItemEx(
        pResult: *mut core::ffi::c_void,  // IMFAsyncResult*
        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 MFScheduleWorkItemEx(IntPtr pResult, long Timeout, IntPtr pKey);
"@
$api = Add-Type -MemberDefinition $sig -Name 'MFPlat_MFScheduleWorkItemEx' -Namespace Win32 -PassThru
# $api::MFScheduleWorkItemEx(pResult, Timeout, pKey)

#uselib "MFPlat.dll"
#func global MFScheduleWorkItemEx "MFScheduleWorkItemEx" sptr, sptr, sptr
; MFScheduleWorkItemEx pResult, Timeout, varptr(pKey)   ; 戻り値は stat
; pResult : IMFAsyncResult* -> "sptr"
; Timeout : LONGLONG -> "sptr"
; pKey : ULONGLONG* optional, out -> "sptr"
; ※HSP3.7は int64 引数(64bit値渡し)に非対応です。
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "MFPlat.dll"
#cfunc global MFScheduleWorkItemEx "MFScheduleWorkItemEx" sptr, int64, var
; res = MFScheduleWorkItemEx(pResult, Timeout, pKey)
; pResult : IMFAsyncResult* -> "sptr"
; Timeout : LONGLONG -> "int64"
; pKey : ULONGLONG* optional, out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
; ※int64 引数の DLL 値渡しは x64 ランタイム(hsp3_64)のみ対応(x86 は未対応)。#uselib "MFPlat.dll"
#cfunc global MFScheduleWorkItemEx "MFScheduleWorkItemEx" sptr, int64, sptr
; res = MFScheduleWorkItemEx(pResult, Timeout, varptr(pKey))
; pResult : IMFAsyncResult* -> "sptr"
; Timeout : LONGLONG -> "int64"
; pKey : ULONGLONG* optional, out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
; ※int64 引数の DLL 値渡しは x64 ランタイム(hsp3_64)のみ対応(x86 は未対応)。