ホーム › Media.MediaFoundation › MFAllocateWorkQueueEx

MFAllocateWorkQueueEx

関数

種別を指定して新しい作業キューを割り当てる。

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

シグネチャ

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

HRESULT MFAllocateWorkQueueEx(
    MFASYNC_WORKQUEUE_TYPE WorkQueueType,
    DWORD* pdwWorkQueue
);

パラメーター

名前

型

方向

説明

WorkQueueType

MFASYNC_WORKQUEUE_TYPE

作成するワークキューの種類を指定する MFASYNC_WORKQUEUE_TYPE 列挙体のメンバーです。

値	意味
MF_MULTITHREADED_WORKQUEUE	マルチスレッドのワークキューを作成します。一般に、アプリケーションでプライベートなマルチスレッドキューを作成すべきではありません。代わりにプラットフォームのマルチスレッドキューを使用してください。詳細については、Work Queue and Threading Improvements を参照してください。
MF_STANDARD_WORKQUEUE	メッセージループを持たないワークキューを作成します。このフラグの使用は、MFAllocateWorkQueue を呼び出すことと同等です。
MF_WINDOW_WORKQUEUE	メッセージループを持つワークキューを作成します。このキューのワークアイテムをディスパッチするスレッドは、PeekMessage および DispatchMessage も呼び出します。コールバックがメッセージループを必要とする処理を行う場合は、このオプションを使用してください。

pdwWorkQueue

DWORD*

out

作成されたワークキューの識別子を受け取ります。

戻り値の型: HRESULT

公式ドキュメント

新しいワークキューを作成します。(MFAllocateWorkQueueEx)

戻り値

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

戻り値	説明
S_OK	関数は成功しました。
E_FAIL	アプリケーションがワークキューの最大数を超えました。
E_INVALIDARG	引数が無効です。
MF_E_SHUTDOWN	アプリケーションが MFStartup を呼び出していないか、すでに MFShutdown を呼び出しています。

解説(Remarks)

ワークキューの使用が終わったら、MFUnlockWorkQueue を呼び出してください。

MFAllocateWorkQueue 関数は、WorkQueueType パラメーターに値 MF_STANDARD_WORKQUEUE を指定して MFAllocateWorkQueueEx を呼び出すことと同等です。

この関数は、Platform Update Supplement for Windows Vista がインストールされている場合に Windows Vista で使用できます。

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

各言語での呼び出し定義

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

HRESULT MFAllocateWorkQueueEx(
    MFASYNC_WORKQUEUE_TYPE WorkQueueType,
    DWORD* pdwWorkQueue
);

[DllImport("MFPlat.dll", ExactSpelling = true)]
static extern int MFAllocateWorkQueueEx(
    int WorkQueueType,   // MFASYNC_WORKQUEUE_TYPE
    out uint pdwWorkQueue   // DWORD* out
);

<DllImport("MFPlat.dll", ExactSpelling:=True)>
Public Shared Function MFAllocateWorkQueueEx(
    WorkQueueType As Integer,   ' MFASYNC_WORKQUEUE_TYPE
    <Out> ByRef pdwWorkQueue As UInteger   ' DWORD* out
) As Integer
End Function

' WorkQueueType : MFASYNC_WORKQUEUE_TYPE
' pdwWorkQueue : DWORD* out
Declare PtrSafe Function MFAllocateWorkQueueEx Lib "mfplat" ( _
    ByVal WorkQueueType As Long, _
    ByRef pdwWorkQueue As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

MFAllocateWorkQueueEx = ctypes.windll.mfplat.MFAllocateWorkQueueEx
MFAllocateWorkQueueEx.restype = ctypes.c_int
MFAllocateWorkQueueEx.argtypes = [
    ctypes.c_int,  # WorkQueueType : MFASYNC_WORKQUEUE_TYPE
    ctypes.POINTER(wintypes.DWORD),  # pdwWorkQueue : DWORD* out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('MFPlat.dll')
MFAllocateWorkQueueEx = Fiddle::Function.new(
  lib['MFAllocateWorkQueueEx'],
  [
    Fiddle::TYPE_INT,  # WorkQueueType : MFASYNC_WORKQUEUE_TYPE
    Fiddle::TYPE_VOIDP,  # pdwWorkQueue : DWORD* out
  ],
  Fiddle::TYPE_INT)

#[link(name = "mfplat")]
extern "system" {
    fn MFAllocateWorkQueueEx(
        WorkQueueType: i32,  // MFASYNC_WORKQUEUE_TYPE
        pdwWorkQueue: *mut u32  // DWORD* out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("MFPlat.dll")]
public static extern int MFAllocateWorkQueueEx(int WorkQueueType, out uint pdwWorkQueue);
"@
$api = Add-Type -MemberDefinition $sig -Name 'MFPlat_MFAllocateWorkQueueEx' -Namespace Win32 -PassThru
# $api::MFAllocateWorkQueueEx(WorkQueueType, pdwWorkQueue)

#uselib "MFPlat.dll"
#func global MFAllocateWorkQueueEx "MFAllocateWorkQueueEx" sptr, sptr
; MFAllocateWorkQueueEx WorkQueueType, varptr(pdwWorkQueue)   ; 戻り値は stat
; WorkQueueType : MFASYNC_WORKQUEUE_TYPE -> "sptr"
; pdwWorkQueue : DWORD* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "MFPlat.dll"
#cfunc global MFAllocateWorkQueueEx "MFAllocateWorkQueueEx" int, var
; res = MFAllocateWorkQueueEx(WorkQueueType, pdwWorkQueue)
; WorkQueueType : MFASYNC_WORKQUEUE_TYPE -> "int"
; pdwWorkQueue : DWORD* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "MFPlat.dll"
#cfunc global MFAllocateWorkQueueEx "MFAllocateWorkQueueEx" int, sptr
; res = MFAllocateWorkQueueEx(WorkQueueType, varptr(pdwWorkQueue))
; WorkQueueType : MFASYNC_WORKQUEUE_TYPE -> "int"
; pdwWorkQueue : DWORD* out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。