ホーム › System.Threading › RtwqEndRegisterWorkQueueWithMMCSS

RtwqEndRegisterWorkQueueWithMMCSS

関数

作業キューのMMCSS登録を完了し、タスクIDを取得する。

DLLRTWorkQ.dll呼出規約winapi対応OSWindows 8.1 以降

シグネチャ

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

HRESULT RtwqEndRegisterWorkQueueWithMMCSS(
    IRtwqAsyncResult* result,
    DWORD* taskId
);

パラメーター

名前	型	方向	説明
result	IRtwqAsyncResult*	in	非同期結果へのポインター。コールバックオブジェクトが IRtwqAsyncCallback::Invoke メソッドで受け取ったものと同じポインターを渡します。
taskId	DWORD*	out	一意のタスク識別子。

戻り値の型: HRESULT

公式ドキュメント

作業キューを Multimedia Class Scheduler Service (MMCSS) タスクに関連付ける非同期要求を完了します。(RtwqEndRegisterWorkQueueWithMMCSS)

戻り値

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

解説(Remarks)

RtwqBeginRegisterWorkQueueWithMMCSSEx 関数が非同期に完了したときに、この関数を呼び出します。

作業キューを MMCSS クラスから登録解除するには、RtwqBeginUnregisterWorkQueueWithMMCSS を呼び出します。

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

各言語での呼び出し定義

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

HRESULT RtwqEndRegisterWorkQueueWithMMCSS(
    IRtwqAsyncResult* result,
    DWORD* taskId
);

[DllImport("RTWorkQ.dll", ExactSpelling = true)]
static extern int RtwqEndRegisterWorkQueueWithMMCSS(
    IntPtr result,   // IRtwqAsyncResult*
    out uint taskId   // DWORD* out
);

<DllImport("RTWorkQ.dll", ExactSpelling:=True)>
Public Shared Function RtwqEndRegisterWorkQueueWithMMCSS(
    result As IntPtr,   ' IRtwqAsyncResult*
    <Out> ByRef taskId As UInteger   ' DWORD* out
) As Integer
End Function

' result : IRtwqAsyncResult*
' taskId : DWORD* out
Declare PtrSafe Function RtwqEndRegisterWorkQueueWithMMCSS Lib "rtworkq" ( _
    ByVal result As LongPtr, _
    ByRef taskId As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

RtwqEndRegisterWorkQueueWithMMCSS = ctypes.windll.rtworkq.RtwqEndRegisterWorkQueueWithMMCSS
RtwqEndRegisterWorkQueueWithMMCSS.restype = ctypes.c_int
RtwqEndRegisterWorkQueueWithMMCSS.argtypes = [
    ctypes.c_void_p,  # result : IRtwqAsyncResult*
    ctypes.POINTER(wintypes.DWORD),  # taskId : DWORD* out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('RTWorkQ.dll')
RtwqEndRegisterWorkQueueWithMMCSS = Fiddle::Function.new(
  lib['RtwqEndRegisterWorkQueueWithMMCSS'],
  [
    Fiddle::TYPE_VOIDP,  # result : IRtwqAsyncResult*
    Fiddle::TYPE_VOIDP,  # taskId : DWORD* out
  ],
  Fiddle::TYPE_INT)

#[link(name = "rtworkq")]
extern "system" {
    fn RtwqEndRegisterWorkQueueWithMMCSS(
        result: *mut core::ffi::c_void,  // IRtwqAsyncResult*
        taskId: *mut u32  // DWORD* out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("RTWorkQ.dll")]
public static extern int RtwqEndRegisterWorkQueueWithMMCSS(IntPtr result, out uint taskId);
"@
$api = Add-Type -MemberDefinition $sig -Name 'RTWorkQ_RtwqEndRegisterWorkQueueWithMMCSS' -Namespace Win32 -PassThru
# $api::RtwqEndRegisterWorkQueueWithMMCSS(result, taskId)

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

出力引数:

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