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

MFGetWorkQueueMMCSSClass

関数
作業キューに関連付けられたMMCSSクラス名を取得する。
DLLMFPlat.dll呼出規約winapi対応OSWindows Vista 以降

シグネチャ

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

HRESULT MFGetWorkQueueMMCSSClass(
    DWORD dwWorkQueueId,
    LPWSTR pwszClass,   // optional
    DWORD* pcchClass
);

パラメーター

名前方向説明
dwWorkQueueIdDWORDinワークキューの識別子です。この識別子は MFAllocateWorkQueue 関数によって取得します。
pwszClassLPWSTRoutoptionalMMCSS クラスの名前を受け取るバッファーへのポインターです。このパラメーターには NULL を指定できます。
pcchClassDWORD*inout入力時には pwszClass バッファーのサイズを文字数で指定します。出力時には必要なバッファーのサイズを文字数で受け取ります。このサイズには終端の null 文字が含まれます。

戻り値の型: HRESULT

公式ドキュメント

このワークキューに現在関連付けられている Multimedia Class Scheduler Service (MMCSS) クラスを取得します。(MFGetWorkQueueMMCSSClass)

戻り値

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

戻り値 説明
S_OK
関数は成功しました。
MF_E_BUFFERTOOSMALL
pwszClass バッファーが小さすぎてタスク名を受け取れません。

解説(Remarks)

ワークキューが MMCSS タスクに関連付けられていない場合、この関数は空の文字列を取得します。

ワークキューを MMCSS タスクに関連付けるには、MFBeginRegisterWorkQueueWithMMCSS を呼び出します。

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

各言語での呼び出し定義

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

HRESULT MFGetWorkQueueMMCSSClass(
    DWORD dwWorkQueueId,
    LPWSTR pwszClass,   // optional
    DWORD* pcchClass
);
[DllImport("MFPlat.dll", ExactSpelling = true)]
static extern int MFGetWorkQueueMMCSSClass(
    uint dwWorkQueueId,   // DWORD
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder pwszClass,   // LPWSTR optional, out
    ref uint pcchClass   // DWORD* in/out
);
<DllImport("MFPlat.dll", ExactSpelling:=True)>
Public Shared Function MFGetWorkQueueMMCSSClass(
    dwWorkQueueId As UInteger,   ' DWORD
    <MarshalAs(UnmanagedType.LPWStr)> pwszClass As System.Text.StringBuilder,   ' LPWSTR optional, out
    ByRef pcchClass As UInteger   ' DWORD* in/out
) As Integer
End Function
' dwWorkQueueId : DWORD
' pwszClass : LPWSTR optional, out
' pcchClass : DWORD* in/out
Declare PtrSafe Function MFGetWorkQueueMMCSSClass Lib "mfplat" ( _
    ByVal dwWorkQueueId As Long, _
    ByVal pwszClass As LongPtr, _
    ByRef pcchClass As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

MFGetWorkQueueMMCSSClass = ctypes.windll.mfplat.MFGetWorkQueueMMCSSClass
MFGetWorkQueueMMCSSClass.restype = ctypes.c_int
MFGetWorkQueueMMCSSClass.argtypes = [
    wintypes.DWORD,  # dwWorkQueueId : DWORD
    wintypes.LPWSTR,  # pwszClass : LPWSTR optional, out
    ctypes.POINTER(wintypes.DWORD),  # pcchClass : DWORD* in/out
]
require 'fiddle'
require 'fiddle/import'

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

var (
	mfplat = windows.NewLazySystemDLL("MFPlat.dll")
	procMFGetWorkQueueMMCSSClass = mfplat.NewProc("MFGetWorkQueueMMCSSClass")
)

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

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

typedef MFGetWorkQueueMMCSSClassNative = Int32 Function(Uint32, Pointer<Utf16>, Pointer<Uint32>);
typedef MFGetWorkQueueMMCSSClassDart = int Function(int, Pointer<Utf16>, Pointer<Uint32>);
final MFGetWorkQueueMMCSSClass = DynamicLibrary.open('MFPlat.dll')
    .lookupFunction<MFGetWorkQueueMMCSSClassNative, MFGetWorkQueueMMCSSClassDart>('MFGetWorkQueueMMCSSClass');
// dwWorkQueueId : DWORD -> Uint32
// pwszClass : LPWSTR optional, out -> Pointer<Utf16>
// pcchClass : DWORD* in/out -> Pointer<Uint32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function MFGetWorkQueueMMCSSClass(
  dwWorkQueueId: DWORD;   // DWORD
  pwszClass: PWideChar;   // LPWSTR optional, out
  pcchClass: Pointer   // DWORD* in/out
): Integer; stdcall;
  external 'MFPlat.dll' name 'MFGetWorkQueueMMCSSClass';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "MFGetWorkQueueMMCSSClass"
  c_MFGetWorkQueueMMCSSClass :: Word32 -> CWString -> Ptr Word32 -> IO Int32
-- dwWorkQueueId : DWORD -> Word32
-- pwszClass : LPWSTR optional, out -> CWString
-- pcchClass : DWORD* in/out -> Ptr Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let mfgetworkqueuemmcssclass =
  foreign "MFGetWorkQueueMMCSSClass"
    (uint32_t @-> (ptr uint16_t) @-> (ptr uint32_t) @-> returning int32_t)
(* dwWorkQueueId : DWORD -> uint32_t *)
(* pwszClass : LPWSTR optional, out -> (ptr uint16_t) *)
(* pcchClass : DWORD* in/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 ("MFGetWorkQueueMMCSSClass" mfget-work-queue-mmcssclass :convention :stdcall) :int32
  (dw-work-queue-id :uint32)   ; DWORD
  (pwsz-class :pointer)   ; LPWSTR optional, out
  (pcch-class :pointer))   ; DWORD* in/out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $MFGetWorkQueueMMCSSClass = Win32::API::More->new('MFPlat',
    'int MFGetWorkQueueMMCSSClass(DWORD dwWorkQueueId, LPWSTR pwszClass, LPVOID pcchClass)');
# my $ret = $MFGetWorkQueueMMCSSClass->Call($dwWorkQueueId, $pwszClass, $pcchClass);
# dwWorkQueueId : DWORD -> DWORD
# pwszClass : LPWSTR optional, out -> LPWSTR
# pcchClass : DWORD* in/out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。