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

MFLockSharedWorkQueue

関数
指定クラスの共有作業キューをロックして取得する。
DLLMFPlat.dll呼出規約winapi対応OSwindows8.0

シグネチャ

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

HRESULT MFLockSharedWorkQueue(
    LPCWSTR wszClass,
    INT BasePriority,
    DWORD* pdwTaskId,
    DWORD* pID
);

パラメーター

名前方向説明
wszClassLPCWSTRinMMCSS タスクの名前です。
BasePriorityINTin

ワークキュースレッドの基本優先度です。

通常優先度のキューを使用する場合(wszClass="")は、値 0 を渡す必要があります。

pdwTaskIdDWORD*inoutMMCSS タスク識別子です。入力時には既存の MCCSS タスクグループ ID を指定するか、新しいタスクグループを作成するために値 0 を使用します。通常優先度のキューを使用する場合(wszClass="")は、NULL を渡す必要があります。出力時には、実際のタスクグループ ID を受け取ります。
pIDDWORD*out新しいワークキューの識別子を受け取ります。この識別子は、ワーク項目をキューに登録する際に使用します。

戻り値の型: HRESULT

公式ドキュメント

共有ワークキューを取得してロックします。(MFLockSharedWorkQueue)

戻り値

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

解説(Remarks)

マルチスレッドワークキューは、スレッドプールを使用してワーク項目をディスパッチします。スレッドが利用可能になるたびに、キューから次のワーク項目を取り出します。ワーク項目は先入れ先出し(FIFO)順で取り出されますが、ワーク項目はシリアル化されません。つまり、ワークキューはあるワーク項目の完了を待たずに、次のワーク項目を開始します。

単一のプロセス内で、Microsoft Media Foundation プラットフォームは、各 Multimedia Class Scheduler Service(MMCSS)タスクに対して最大 1 つのマルチスレッドキューを作成します。MFLockSharedWorkQueue 関数は、一致するワークキューが既に存在するかどうかを確認します。存在しない場合、この関数は新しいワークキューを作成し、そのワークキューを MMCSS に登録します。この関数は、MMCSS タスク識別子(pdwTaskId)とワークキュー識別子(pID)を返します。ワーク項目をキューに登録するには、ワークキュー識別子を次のいずれかの関数に渡します。

MFLockSharedWorkQueue 関数は、キューのロックも行います。プロセスが終了する前に、MFUnlockWorkQueue を呼び出してワークキューのロックを解除してください。

通常優先度のキューを使用する場合(wszClass="")は、pdwTaskId に NULL を渡し、BasePriority に値 0 を渡す必要があります。

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

各言語での呼び出し定義

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

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

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

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

var (
	mfplat = windows.NewLazySystemDLL("MFPlat.dll")
	procMFLockSharedWorkQueue = mfplat.NewProc("MFLockSharedWorkQueue")
)

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

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

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

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

let mflocksharedworkqueue =
  foreign "MFLockSharedWorkQueue"
    ((ptr uint16_t) @-> int32_t @-> (ptr uint32_t) @-> (ptr uint32_t) @-> returning int32_t)
(* wszClass : LPCWSTR -> (ptr uint16_t) *)
(* BasePriority : INT -> int32_t *)
(* pdwTaskId : DWORD* in/out -> (ptr uint32_t) *)
(* pID : DWORD* 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 ("MFLockSharedWorkQueue" mflock-shared-work-queue :convention :stdcall) :int32
  (wsz-class (:string :encoding :utf-16le))   ; LPCWSTR
  (base-priority :int32)   ; INT
  (pdw-task-id :pointer)   ; DWORD* in/out
  (p-id :pointer))   ; DWORD* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $MFLockSharedWorkQueue = Win32::API::More->new('MFPlat',
    'int MFLockSharedWorkQueue(LPCWSTR wszClass, int BasePriority, LPVOID pdwTaskId, LPVOID pID)');
# my $ret = $MFLockSharedWorkQueue->Call($wszClass, $BasePriority, $pdwTaskId, $pID);
# wszClass : LPCWSTR -> LPCWSTR
# BasePriority : INT -> int
# pdwTaskId : DWORD* in/out -> LPVOID
# pID : DWORD* out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。