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

MFRegisterPlatformWithMMCSS

関数
プラットフォーム作業キューをMMCSSタスクへ登録する。
DLLMFPlat.dll呼出規約winapi対応OSwindows8.0

シグネチャ

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

HRESULT MFRegisterPlatformWithMMCSS(
    LPCWSTR wszClass,
    DWORD* pdwTaskId,
    INT lPriority
);

パラメーター

名前方向説明
wszClassLPCWSTRinMMCSS タスクの名前です。
pdwTaskIdDWORD*inoutMMCSS タスク識別子です。入力時には、既存の MMCSS タスクグループ ID を指定するか、新しいタスクグループを作成する場合は値 0 を使用します。出力時には、実際のタスクグループ ID を受け取ります。
lPriorityINTin作業キュースレッドの基本優先度です。

戻り値の型: HRESULT

公式ドキュメント

標準の Microsoft Media Foundation プラットフォーム作業キューを Multimedia Class Scheduler Service (MMCSS) に登録します。

戻り値

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

解説(Remarks)

プラットフォーム作業キューを MMCSS クラスから登録解除するには、MFUnregisterPlatformFromMMCSS を呼び出します。

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

各言語での呼び出し定義

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

HRESULT MFRegisterPlatformWithMMCSS(
    LPCWSTR wszClass,
    DWORD* pdwTaskId,
    INT lPriority
);
[DllImport("MFPlat.dll", ExactSpelling = true)]
static extern int MFRegisterPlatformWithMMCSS(
    [MarshalAs(UnmanagedType.LPWStr)] string wszClass,   // LPCWSTR
    ref uint pdwTaskId,   // DWORD* in/out
    int lPriority   // INT
);
<DllImport("MFPlat.dll", ExactSpelling:=True)>
Public Shared Function MFRegisterPlatformWithMMCSS(
    <MarshalAs(UnmanagedType.LPWStr)> wszClass As String,   ' LPCWSTR
    ByRef pdwTaskId As UInteger,   ' DWORD* in/out
    lPriority As Integer   ' INT
) As Integer
End Function
' wszClass : LPCWSTR
' pdwTaskId : DWORD* in/out
' lPriority : INT
Declare PtrSafe Function MFRegisterPlatformWithMMCSS Lib "mfplat" ( _
    ByVal wszClass As LongPtr, _
    ByRef pdwTaskId As Long, _
    ByVal lPriority As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

MFRegisterPlatformWithMMCSS = ctypes.windll.mfplat.MFRegisterPlatformWithMMCSS
MFRegisterPlatformWithMMCSS.restype = ctypes.c_int
MFRegisterPlatformWithMMCSS.argtypes = [
    wintypes.LPCWSTR,  # wszClass : LPCWSTR
    ctypes.POINTER(wintypes.DWORD),  # pdwTaskId : DWORD* in/out
    ctypes.c_int,  # lPriority : INT
]
require 'fiddle'
require 'fiddle/import'

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

var (
	mfplat = windows.NewLazySystemDLL("MFPlat.dll")
	procMFRegisterPlatformWithMMCSS = mfplat.NewProc("MFRegisterPlatformWithMMCSS")
)

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

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

typedef MFRegisterPlatformWithMMCSSNative = Int32 Function(Pointer<Utf16>, Pointer<Uint32>, Int32);
typedef MFRegisterPlatformWithMMCSSDart = int Function(Pointer<Utf16>, Pointer<Uint32>, int);
final MFRegisterPlatformWithMMCSS = DynamicLibrary.open('MFPlat.dll')
    .lookupFunction<MFRegisterPlatformWithMMCSSNative, MFRegisterPlatformWithMMCSSDart>('MFRegisterPlatformWithMMCSS');
// wszClass : LPCWSTR -> Pointer<Utf16>
// pdwTaskId : DWORD* in/out -> Pointer<Uint32>
// lPriority : INT -> Int32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function MFRegisterPlatformWithMMCSS(
  wszClass: PWideChar;   // LPCWSTR
  pdwTaskId: Pointer;   // DWORD* in/out
  lPriority: Integer   // INT
): Integer; stdcall;
  external 'MFPlat.dll' name 'MFRegisterPlatformWithMMCSS';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "MFRegisterPlatformWithMMCSS"
  c_MFRegisterPlatformWithMMCSS :: CWString -> Ptr Word32 -> Int32 -> IO Int32
-- wszClass : LPCWSTR -> CWString
-- pdwTaskId : DWORD* in/out -> Ptr Word32
-- lPriority : INT -> Int32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let mfregisterplatformwithmmcss =
  foreign "MFRegisterPlatformWithMMCSS"
    ((ptr uint16_t) @-> (ptr uint32_t) @-> int32_t @-> returning int32_t)
(* wszClass : LPCWSTR -> (ptr uint16_t) *)
(* pdwTaskId : DWORD* in/out -> (ptr uint32_t) *)
(* lPriority : INT -> int32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library mfplat (t "MFPlat.dll"))
(cffi:use-foreign-library mfplat)

(cffi:defcfun ("MFRegisterPlatformWithMMCSS" mfregister-platform-with-mmcss :convention :stdcall) :int32
  (wsz-class (:string :encoding :utf-16le))   ; LPCWSTR
  (pdw-task-id :pointer)   ; DWORD* in/out
  (l-priority :int32))   ; INT
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $MFRegisterPlatformWithMMCSS = Win32::API::More->new('MFPlat',
    'int MFRegisterPlatformWithMMCSS(LPCWSTR wszClass, LPVOID pdwTaskId, int lPriority)');
# my $ret = $MFRegisterPlatformWithMMCSS->Call($wszClass, $pdwTaskId, $lPriority);
# wszClass : LPCWSTR -> LPCWSTR
# pdwTaskId : DWORD* in/out -> LPVOID
# lPriority : INT -> int
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。