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

MFLockWorkQueue

関数
指定した作業キューをロックして保持する。
DLLMFPlat.dll呼出規約winapi対応OSWindows Vista 以降

シグネチャ

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

HRESULT MFLockWorkQueue(
    DWORD dwWorkQueue
);

パラメーター

名前方向説明
dwWorkQueueDWORDin作業キューの識別子。この識別子は MFAllocateWorkQueue 関数によって返されます。

戻り値の型: HRESULT

公式ドキュメント

作業キューをロックします。 (MFLockWorkQueue)

戻り値

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

解説(Remarks)

この関数は、MFShutdown 関数が作業キューをシャットダウンするのを防ぎます。プラットフォームがシャットダウンする前に、作業キュー上の非同期操作が正常に完了するようにするには、この関数を使用します。MFShutdown 関数は、作業キューのロックが解除されるまで、または一定の待機時間が経過するまでブロックします (待機時間は数秒です)。

作業キューのロックを解除するには MFUnlockWorkQueue を呼び出します。MFLockWorkQueue の各呼び出しには、対応する MFUnlockWorkQueue の呼び出しが必要です。

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

各言語での呼び出し定義

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

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

MFLockWorkQueue = ctypes.windll.mfplat.MFLockWorkQueue
MFLockWorkQueue.restype = ctypes.c_int
MFLockWorkQueue.argtypes = [
    wintypes.DWORD,  # dwWorkQueue : DWORD
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('MFPlat.dll')
MFLockWorkQueue = Fiddle::Function.new(
  lib['MFLockWorkQueue'],
  [
    -Fiddle::TYPE_INT,  # dwWorkQueue : DWORD
  ],
  Fiddle::TYPE_INT)
#[link(name = "mfplat")]
extern "system" {
    fn MFLockWorkQueue(
        dwWorkQueue: u32  // DWORD
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("MFPlat.dll")]
public static extern int MFLockWorkQueue(uint dwWorkQueue);
"@
$api = Add-Type -MemberDefinition $sig -Name 'MFPlat_MFLockWorkQueue' -Namespace Win32 -PassThru
# $api::MFLockWorkQueue(dwWorkQueue)
#uselib "MFPlat.dll"
#func global MFLockWorkQueue "MFLockWorkQueue" sptr
; MFLockWorkQueue dwWorkQueue   ; 戻り値は stat
; dwWorkQueue : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "MFPlat.dll"
#cfunc global MFLockWorkQueue "MFLockWorkQueue" int
; res = MFLockWorkQueue(dwWorkQueue)
; dwWorkQueue : DWORD -> "int"
; HRESULT MFLockWorkQueue(DWORD dwWorkQueue)
#uselib "MFPlat.dll"
#cfunc global MFLockWorkQueue "MFLockWorkQueue" int
; res = MFLockWorkQueue(dwWorkQueue)
; dwWorkQueue : DWORD -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	mfplat = windows.NewLazySystemDLL("MFPlat.dll")
	procMFLockWorkQueue = mfplat.NewProc("MFLockWorkQueue")
)

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

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

typedef MFLockWorkQueueNative = Int32 Function(Uint32);
typedef MFLockWorkQueueDart = int Function(int);
final MFLockWorkQueue = DynamicLibrary.open('MFPlat.dll')
    .lookupFunction<MFLockWorkQueueNative, MFLockWorkQueueDart>('MFLockWorkQueue');
// dwWorkQueue : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function MFLockWorkQueue(
  dwWorkQueue: DWORD   // DWORD
): Integer; stdcall;
  external 'MFPlat.dll' name 'MFLockWorkQueue';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "MFLockWorkQueue"
  c_MFLockWorkQueue :: Word32 -> IO Int32
-- dwWorkQueue : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let mflockworkqueue =
  foreign "MFLockWorkQueue"
    (uint32_t @-> returning int32_t)
(* dwWorkQueue : DWORD -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library mfplat (t "MFPlat.dll"))
(cffi:use-foreign-library mfplat)

(cffi:defcfun ("MFLockWorkQueue" mflock-work-queue :convention :stdcall) :int32
  (dw-work-queue :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $MFLockWorkQueue = Win32::API::More->new('MFPlat',
    'int MFLockWorkQueue(DWORD dwWorkQueue)');
# my $ret = $MFLockWorkQueue->Call($dwWorkQueue);
# dwWorkQueue : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。