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

MFAddPeriodicCallback

関数
一定周期で呼び出される定期コールバックを登録する。
DLLMFPlat.dll呼出規約winapi対応OSWindows Vista 以降

シグネチャ

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

HRESULT MFAddPeriodicCallback(
    MFPERIODICCALLBACK Callback,
    IUnknown* pContext,
    DWORD* pdwKey   // optional
);

パラメーター

名前方向説明
CallbackMFPERIODICCALLBACKinMFPERIODICCALLBACK 型のコールバック関数へのポインターです。
pContextIUnknown*inIUnknown を実装する呼び出し側提供のオブジェクトへのポインター、または NULL です。このパラメーターはコールバック関数に渡されます。
pdwKeyDWORD*outoptionalコールバックをキャンセルするために使用できるキーを受け取ります。コールバックをキャンセルするには、MFRemovePeriodicCallback を呼び出し、このキーを dwKey パラメーターとして渡します。

戻り値の型: HRESULT

公式ドキュメント

一定の間隔で呼び出されるコールバック関数を設定します。(MFAddPeriodicCallback)

戻り値

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

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

解説(Remarks)

定期コールバックのタイマー間隔を取得するには、MFGetTimerPeriodicity を呼び出します。

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

各言語での呼び出し定義

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

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

MFAddPeriodicCallback = ctypes.windll.mfplat.MFAddPeriodicCallback
MFAddPeriodicCallback.restype = ctypes.c_int
MFAddPeriodicCallback.argtypes = [
    ctypes.c_void_p,  # Callback : MFPERIODICCALLBACK
    ctypes.c_void_p,  # pContext : IUnknown*
    ctypes.POINTER(wintypes.DWORD),  # pdwKey : DWORD* optional, out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('MFPlat.dll')
MFAddPeriodicCallback = Fiddle::Function.new(
  lib['MFAddPeriodicCallback'],
  [
    Fiddle::TYPE_VOIDP,  # Callback : MFPERIODICCALLBACK
    Fiddle::TYPE_VOIDP,  # pContext : IUnknown*
    Fiddle::TYPE_VOIDP,  # pdwKey : DWORD* optional, out
  ],
  Fiddle::TYPE_INT)
#[link(name = "mfplat")]
extern "system" {
    fn MFAddPeriodicCallback(
        Callback: *const core::ffi::c_void,  // MFPERIODICCALLBACK
        pContext: *mut core::ffi::c_void,  // IUnknown*
        pdwKey: *mut u32  // DWORD* optional, out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("MFPlat.dll")]
public static extern int MFAddPeriodicCallback(IntPtr Callback, IntPtr pContext, IntPtr pdwKey);
"@
$api = Add-Type -MemberDefinition $sig -Name 'MFPlat_MFAddPeriodicCallback' -Namespace Win32 -PassThru
# $api::MFAddPeriodicCallback(Callback, pContext, pdwKey)
#uselib "MFPlat.dll"
#func global MFAddPeriodicCallback "MFAddPeriodicCallback" sptr, sptr, sptr
; MFAddPeriodicCallback Callback, pContext, varptr(pdwKey)   ; 戻り値は stat
; Callback : MFPERIODICCALLBACK -> "sptr"
; pContext : IUnknown* -> "sptr"
; pdwKey : DWORD* optional, out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "MFPlat.dll"
#cfunc global MFAddPeriodicCallback "MFAddPeriodicCallback" sptr, sptr, var
; res = MFAddPeriodicCallback(Callback, pContext, pdwKey)
; Callback : MFPERIODICCALLBACK -> "sptr"
; pContext : IUnknown* -> "sptr"
; pdwKey : DWORD* optional, out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; HRESULT MFAddPeriodicCallback(MFPERIODICCALLBACK Callback, IUnknown* pContext, DWORD* pdwKey)
#uselib "MFPlat.dll"
#cfunc global MFAddPeriodicCallback "MFAddPeriodicCallback" intptr, intptr, var
; res = MFAddPeriodicCallback(Callback, pContext, pdwKey)
; Callback : MFPERIODICCALLBACK -> "intptr"
; pContext : IUnknown* -> "intptr"
; pdwKey : DWORD* optional, out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	mfplat = windows.NewLazySystemDLL("MFPlat.dll")
	procMFAddPeriodicCallback = mfplat.NewProc("MFAddPeriodicCallback")
)

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

extern "mfplat" fn MFAddPeriodicCallback(
    Callback: ?*anyopaque, // MFPERIODICCALLBACK
    pContext: ?*anyopaque, // IUnknown*
    pdwKey: [*c]u32 // DWORD* optional, out
) callconv(std.os.windows.WINAPI) i32;
proc MFAddPeriodicCallback(
    Callback: pointer,  # MFPERIODICCALLBACK
    pContext: pointer,  # IUnknown*
    pdwKey: ptr uint32  # DWORD* optional, out
): int32 {.importc: "MFAddPeriodicCallback", stdcall, dynlib: "MFPlat.dll".}
pragma(lib, "mfplat");
extern(Windows)
int MFAddPeriodicCallback(
    void* Callback,   // MFPERIODICCALLBACK
    void* pContext,   // IUnknown*
    uint* pdwKey   // DWORD* optional, out
);
ccall((:MFAddPeriodicCallback, "MFPlat.dll"), stdcall, Int32,
      (Ptr{Cvoid}, Ptr{Cvoid}, Ptr{UInt32}),
      Callback, pContext, pdwKey)
# Callback : MFPERIODICCALLBACK -> Ptr{Cvoid}
# pContext : IUnknown* -> Ptr{Cvoid}
# pdwKey : DWORD* optional, out -> Ptr{UInt32}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t MFAddPeriodicCallback(
    void* Callback,
    void* pContext,
    uint32_t* pdwKey);
]]
local mfplat = ffi.load("mfplat")
-- mfplat.MFAddPeriodicCallback(Callback, pContext, pdwKey)
-- Callback : MFPERIODICCALLBACK
-- pContext : IUnknown*
-- pdwKey : DWORD* optional, out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('MFPlat.dll');
const MFAddPeriodicCallback = lib.func('__stdcall', 'MFAddPeriodicCallback', 'int32_t', ['void *', 'void *', 'uint32_t *']);
// MFAddPeriodicCallback(Callback, pContext, pdwKey)
// Callback : MFPERIODICCALLBACK -> 'void *'
// pContext : IUnknown* -> 'void *'
// pdwKey : DWORD* optional, out -> 'uint32_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
// コールバック(関数ポインタ)は koffi.proto/koffi.register で型を定義して渡す(素の void* では JS 関数を渡せない)。
const lib = Deno.dlopen("MFPlat.dll", {
  MFAddPeriodicCallback: { parameters: ["pointer", "pointer", "pointer"], result: "i32" },
});
// lib.symbols.MFAddPeriodicCallback(Callback, pContext, pdwKey)
// Callback : MFPERIODICCALLBACK -> "pointer"
// pContext : IUnknown* -> "pointer"
// pdwKey : DWORD* optional, out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t MFAddPeriodicCallback(
    void* Callback,
    void* pContext,
    uint32_t* pdwKey);
C, "MFPlat.dll");
// $ffi->MFAddPeriodicCallback(Callback, pContext, pdwKey);
// Callback : MFPERIODICCALLBACK
// pContext : IUnknown*
// pdwKey : DWORD* 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 MFAddPeriodicCallback(
        Callback Callback,   // MFPERIODICCALLBACK
        Pointer pContext,   // IUnknown*
        IntByReference pdwKey   // DWORD* optional, out
    );
}
@[Link("mfplat")]
lib LibMFPlat
  fun MFAddPeriodicCallback = MFAddPeriodicCallback(
    Callback : Void*,   # MFPERIODICCALLBACK
    pContext : Void*,   # IUnknown*
    pdwKey : UInt32*   # DWORD* 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 MFAddPeriodicCallbackNative = Int32 Function(Pointer<Void>, Pointer<Void>, Pointer<Uint32>);
typedef MFAddPeriodicCallbackDart = int Function(Pointer<Void>, Pointer<Void>, Pointer<Uint32>);
final MFAddPeriodicCallback = DynamicLibrary.open('MFPlat.dll')
    .lookupFunction<MFAddPeriodicCallbackNative, MFAddPeriodicCallbackDart>('MFAddPeriodicCallback');
// Callback : MFPERIODICCALLBACK -> Pointer<Void>
// pContext : IUnknown* -> Pointer<Void>
// pdwKey : DWORD* optional, out -> Pointer<Uint32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function MFAddPeriodicCallback(
  Callback: Pointer;   // MFPERIODICCALLBACK
  pContext: Pointer;   // IUnknown*
  pdwKey: Pointer   // DWORD* optional, out
): Integer; stdcall;
  external 'MFPlat.dll' name 'MFAddPeriodicCallback';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "MFAddPeriodicCallback"
  c_MFAddPeriodicCallback :: Ptr () -> Ptr () -> Ptr Word32 -> IO Int32
-- Callback : MFPERIODICCALLBACK -> Ptr ()
-- pContext : IUnknown* -> Ptr ()
-- pdwKey : DWORD* optional, out -> Ptr Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let mfaddperiodiccallback =
  foreign "MFAddPeriodicCallback"
    ((ptr void) @-> (ptr void) @-> (ptr uint32_t) @-> returning int32_t)
(* Callback : MFPERIODICCALLBACK -> (ptr void) *)
(* pContext : IUnknown* -> (ptr void) *)
(* pdwKey : DWORD* optional, out -> (ptr uint32_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library mfplat (t "MFPlat.dll"))
(cffi:use-foreign-library mfplat)

(cffi:defcfun ("MFAddPeriodicCallback" mfadd-periodic-callback :convention :stdcall) :int32
  (callback :pointer)   ; MFPERIODICCALLBACK
  (p-context :pointer)   ; IUnknown*
  (pdw-key :pointer))   ; DWORD* optional, out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $MFAddPeriodicCallback = Win32::API::More->new('MFPlat',
    'int MFAddPeriodicCallback(LPVOID Callback, LPVOID pContext, LPVOID pdwKey)');
# my $ret = $MFAddPeriodicCallback->Call($Callback, $pContext, $pdwKey);
# Callback : MFPERIODICCALLBACK -> LPVOID
# pContext : IUnknown* -> LPVOID
# pdwKey : DWORD* optional, out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# コールバック(関数ポインタ)は Perl sub を直接渡せません。Win32::API::Callback を使用してください。

関連項目

使用する型