Win32 API 日本語リファレンス
ホームSystem.Threading › RtwqBeginRegisterWorkQueueWithMMCSS

RtwqBeginRegisterWorkQueueWithMMCSS

関数
作業キューのMMCSSへの非同期登録を開始する。
DLLRTWorkQ.dll呼出規約winapi対応OSWindows 8.1 以降

シグネチャ

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

HRESULT RtwqBeginRegisterWorkQueueWithMMCSS(
    DWORD workQueueId,
    LPCWSTR usageClass,
    DWORD dwTaskId,
    INT lPriority,
    IRtwqAsyncCallback* doneCallback,
    IUnknown* doneState
);

パラメーター

名前方向説明
workQueueIdDWORDinワークキューの識別子です。プライベートワークキューの場合、識別子は RtwqAllocateWorkQueue 関数によって返されます。
usageClassLPCWSTRinMMCSS タスクの名前です。
dwTaskIdDWORDin一意のタスク識別子です。新しいタスク識別子を取得するには、この値を 0 に設定します。
lPriorityINTinワークキュースレッドの基準となる相対優先度です。詳細については、AvSetMmThreadPriority を参照してください。
doneCallbackIRtwqAsyncCallback*inコールバックオブジェクトの IRtwqAsyncCallback インターフェイスへのポインターです。呼び出し元はこのインターフェイスを実装する必要があります。
doneStateIUnknown*in呼び出し元が定義する状態オブジェクトの IUnknown インターフェイスへのポインターです。このパラメーターは NULL にすることができます。このオブジェクトは状態情報を保持するために使用できます。コールバックが呼び出される際に、オブジェクトが呼び出し元に返されます。

戻り値の型: HRESULT

公式ドキュメント

ワークキューを Multimedia Class Scheduler Service (MMCSS) のタスクに関連付けます。(RtwqBeginRegisterWorkQueueWithMMCSS)

戻り値

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

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

各言語での呼び出し定義

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

HRESULT RtwqBeginRegisterWorkQueueWithMMCSS(
    DWORD workQueueId,
    LPCWSTR usageClass,
    DWORD dwTaskId,
    INT lPriority,
    IRtwqAsyncCallback* doneCallback,
    IUnknown* doneState
);
[DllImport("RTWorkQ.dll", ExactSpelling = true)]
static extern int RtwqBeginRegisterWorkQueueWithMMCSS(
    uint workQueueId,   // DWORD
    [MarshalAs(UnmanagedType.LPWStr)] string usageClass,   // LPCWSTR
    uint dwTaskId,   // DWORD
    int lPriority,   // INT
    IntPtr doneCallback,   // IRtwqAsyncCallback*
    IntPtr doneState   // IUnknown*
);
<DllImport("RTWorkQ.dll", ExactSpelling:=True)>
Public Shared Function RtwqBeginRegisterWorkQueueWithMMCSS(
    workQueueId As UInteger,   ' DWORD
    <MarshalAs(UnmanagedType.LPWStr)> usageClass As String,   ' LPCWSTR
    dwTaskId As UInteger,   ' DWORD
    lPriority As Integer,   ' INT
    doneCallback As IntPtr,   ' IRtwqAsyncCallback*
    doneState As IntPtr   ' IUnknown*
) As Integer
End Function
' workQueueId : DWORD
' usageClass : LPCWSTR
' dwTaskId : DWORD
' lPriority : INT
' doneCallback : IRtwqAsyncCallback*
' doneState : IUnknown*
Declare PtrSafe Function RtwqBeginRegisterWorkQueueWithMMCSS Lib "rtworkq" ( _
    ByVal workQueueId As Long, _
    ByVal usageClass As LongPtr, _
    ByVal dwTaskId As Long, _
    ByVal lPriority As Long, _
    ByVal doneCallback As LongPtr, _
    ByVal doneState As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

RtwqBeginRegisterWorkQueueWithMMCSS = ctypes.windll.rtworkq.RtwqBeginRegisterWorkQueueWithMMCSS
RtwqBeginRegisterWorkQueueWithMMCSS.restype = ctypes.c_int
RtwqBeginRegisterWorkQueueWithMMCSS.argtypes = [
    wintypes.DWORD,  # workQueueId : DWORD
    wintypes.LPCWSTR,  # usageClass : LPCWSTR
    wintypes.DWORD,  # dwTaskId : DWORD
    ctypes.c_int,  # lPriority : INT
    ctypes.c_void_p,  # doneCallback : IRtwqAsyncCallback*
    ctypes.c_void_p,  # doneState : IUnknown*
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('RTWorkQ.dll')
RtwqBeginRegisterWorkQueueWithMMCSS = Fiddle::Function.new(
  lib['RtwqBeginRegisterWorkQueueWithMMCSS'],
  [
    -Fiddle::TYPE_INT,  # workQueueId : DWORD
    Fiddle::TYPE_VOIDP,  # usageClass : LPCWSTR
    -Fiddle::TYPE_INT,  # dwTaskId : DWORD
    Fiddle::TYPE_INT,  # lPriority : INT
    Fiddle::TYPE_VOIDP,  # doneCallback : IRtwqAsyncCallback*
    Fiddle::TYPE_VOIDP,  # doneState : IUnknown*
  ],
  Fiddle::TYPE_INT)
#[link(name = "rtworkq")]
extern "system" {
    fn RtwqBeginRegisterWorkQueueWithMMCSS(
        workQueueId: u32,  // DWORD
        usageClass: *const u16,  // LPCWSTR
        dwTaskId: u32,  // DWORD
        lPriority: i32,  // INT
        doneCallback: *mut core::ffi::c_void,  // IRtwqAsyncCallback*
        doneState: *mut core::ffi::c_void  // IUnknown*
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("RTWorkQ.dll")]
public static extern int RtwqBeginRegisterWorkQueueWithMMCSS(uint workQueueId, [MarshalAs(UnmanagedType.LPWStr)] string usageClass, uint dwTaskId, int lPriority, IntPtr doneCallback, IntPtr doneState);
"@
$api = Add-Type -MemberDefinition $sig -Name 'RTWorkQ_RtwqBeginRegisterWorkQueueWithMMCSS' -Namespace Win32 -PassThru
# $api::RtwqBeginRegisterWorkQueueWithMMCSS(workQueueId, usageClass, dwTaskId, lPriority, doneCallback, doneState)
#uselib "RTWorkQ.dll"
#func global RtwqBeginRegisterWorkQueueWithMMCSS "RtwqBeginRegisterWorkQueueWithMMCSS" sptr, sptr, sptr, sptr, sptr, sptr
; RtwqBeginRegisterWorkQueueWithMMCSS workQueueId, usageClass, dwTaskId, lPriority, doneCallback, doneState   ; 戻り値は stat
; workQueueId : DWORD -> "sptr"
; usageClass : LPCWSTR -> "sptr"
; dwTaskId : DWORD -> "sptr"
; lPriority : INT -> "sptr"
; doneCallback : IRtwqAsyncCallback* -> "sptr"
; doneState : IUnknown* -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "RTWorkQ.dll"
#cfunc global RtwqBeginRegisterWorkQueueWithMMCSS "RtwqBeginRegisterWorkQueueWithMMCSS" int, wstr, int, int, sptr, sptr
; res = RtwqBeginRegisterWorkQueueWithMMCSS(workQueueId, usageClass, dwTaskId, lPriority, doneCallback, doneState)
; workQueueId : DWORD -> "int"
; usageClass : LPCWSTR -> "wstr"
; dwTaskId : DWORD -> "int"
; lPriority : INT -> "int"
; doneCallback : IRtwqAsyncCallback* -> "sptr"
; doneState : IUnknown* -> "sptr"
; HRESULT RtwqBeginRegisterWorkQueueWithMMCSS(DWORD workQueueId, LPCWSTR usageClass, DWORD dwTaskId, INT lPriority, IRtwqAsyncCallback* doneCallback, IUnknown* doneState)
#uselib "RTWorkQ.dll"
#cfunc global RtwqBeginRegisterWorkQueueWithMMCSS "RtwqBeginRegisterWorkQueueWithMMCSS" int, wstr, int, int, intptr, intptr
; res = RtwqBeginRegisterWorkQueueWithMMCSS(workQueueId, usageClass, dwTaskId, lPriority, doneCallback, doneState)
; workQueueId : DWORD -> "int"
; usageClass : LPCWSTR -> "wstr"
; dwTaskId : DWORD -> "int"
; lPriority : INT -> "int"
; doneCallback : IRtwqAsyncCallback* -> "intptr"
; doneState : IUnknown* -> "intptr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	rtworkq = windows.NewLazySystemDLL("RTWorkQ.dll")
	procRtwqBeginRegisterWorkQueueWithMMCSS = rtworkq.NewProc("RtwqBeginRegisterWorkQueueWithMMCSS")
)

// workQueueId (DWORD), usageClass (LPCWSTR), dwTaskId (DWORD), lPriority (INT), doneCallback (IRtwqAsyncCallback*), doneState (IUnknown*)
r1, _, err := procRtwqBeginRegisterWorkQueueWithMMCSS.Call(
	uintptr(workQueueId),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(usageClass))),
	uintptr(dwTaskId),
	uintptr(lPriority),
	uintptr(doneCallback),
	uintptr(doneState),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // HRESULT
function RtwqBeginRegisterWorkQueueWithMMCSS(
  workQueueId: DWORD;   // DWORD
  usageClass: PWideChar;   // LPCWSTR
  dwTaskId: DWORD;   // DWORD
  lPriority: Integer;   // INT
  doneCallback: Pointer;   // IRtwqAsyncCallback*
  doneState: Pointer   // IUnknown*
): Integer; stdcall;
  external 'RTWorkQ.dll' name 'RtwqBeginRegisterWorkQueueWithMMCSS';
result := DllCall("RTWorkQ\RtwqBeginRegisterWorkQueueWithMMCSS"
    , "UInt", workQueueId   ; DWORD
    , "WStr", usageClass   ; LPCWSTR
    , "UInt", dwTaskId   ; DWORD
    , "Int", lPriority   ; INT
    , "Ptr", doneCallback   ; IRtwqAsyncCallback*
    , "Ptr", doneState   ; IUnknown*
    , "Int")   ; return: HRESULT
●RtwqBeginRegisterWorkQueueWithMMCSS(workQueueId, usageClass, dwTaskId, lPriority, doneCallback, doneState) = DLL("RTWorkQ.dll", "int RtwqBeginRegisterWorkQueueWithMMCSS(dword, char*, dword, int, void*, void*)")
# 呼び出し: RtwqBeginRegisterWorkQueueWithMMCSS(workQueueId, usageClass, dwTaskId, lPriority, doneCallback, doneState)
# workQueueId : DWORD -> "dword"
# usageClass : LPCWSTR -> "char*"
# dwTaskId : DWORD -> "dword"
# lPriority : INT -> "int"
# doneCallback : IRtwqAsyncCallback* -> "void*"
# doneState : IUnknown* -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

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

typedef RtwqBeginRegisterWorkQueueWithMMCSSNative = Int32 Function(Uint32, Pointer<Utf16>, Uint32, Int32, Pointer<Void>, Pointer<Void>);
typedef RtwqBeginRegisterWorkQueueWithMMCSSDart = int Function(int, Pointer<Utf16>, int, int, Pointer<Void>, Pointer<Void>);
final RtwqBeginRegisterWorkQueueWithMMCSS = DynamicLibrary.open('RTWorkQ.dll')
    .lookupFunction<RtwqBeginRegisterWorkQueueWithMMCSSNative, RtwqBeginRegisterWorkQueueWithMMCSSDart>('RtwqBeginRegisterWorkQueueWithMMCSS');
// workQueueId : DWORD -> Uint32
// usageClass : LPCWSTR -> Pointer<Utf16>
// dwTaskId : DWORD -> Uint32
// lPriority : INT -> Int32
// doneCallback : IRtwqAsyncCallback* -> Pointer<Void>
// doneState : IUnknown* -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function RtwqBeginRegisterWorkQueueWithMMCSS(
  workQueueId: DWORD;   // DWORD
  usageClass: PWideChar;   // LPCWSTR
  dwTaskId: DWORD;   // DWORD
  lPriority: Integer;   // INT
  doneCallback: Pointer;   // IRtwqAsyncCallback*
  doneState: Pointer   // IUnknown*
): Integer; stdcall;
  external 'RTWorkQ.dll' name 'RtwqBeginRegisterWorkQueueWithMMCSS';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "RtwqBeginRegisterWorkQueueWithMMCSS"
  c_RtwqBeginRegisterWorkQueueWithMMCSS :: Word32 -> CWString -> Word32 -> Int32 -> Ptr () -> Ptr () -> IO Int32
-- workQueueId : DWORD -> Word32
-- usageClass : LPCWSTR -> CWString
-- dwTaskId : DWORD -> Word32
-- lPriority : INT -> Int32
-- doneCallback : IRtwqAsyncCallback* -> Ptr ()
-- doneState : IUnknown* -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let rtwqbeginregisterworkqueuewithmmcss =
  foreign "RtwqBeginRegisterWorkQueueWithMMCSS"
    (uint32_t @-> (ptr uint16_t) @-> uint32_t @-> int32_t @-> (ptr void) @-> (ptr void) @-> returning int32_t)
(* workQueueId : DWORD -> uint32_t *)
(* usageClass : LPCWSTR -> (ptr uint16_t) *)
(* dwTaskId : DWORD -> uint32_t *)
(* lPriority : INT -> int32_t *)
(* doneCallback : IRtwqAsyncCallback* -> (ptr void) *)
(* doneState : IUnknown* -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library rtworkq (t "RTWorkQ.dll"))
(cffi:use-foreign-library rtworkq)

(cffi:defcfun ("RtwqBeginRegisterWorkQueueWithMMCSS" rtwq-begin-register-work-queue-with-mmcss :convention :stdcall) :int32
  (work-queue-id :uint32)   ; DWORD
  (usage-class (:string :encoding :utf-16le))   ; LPCWSTR
  (dw-task-id :uint32)   ; DWORD
  (l-priority :int32)   ; INT
  (done-callback :pointer)   ; IRtwqAsyncCallback*
  (done-state :pointer))   ; IUnknown*
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $RtwqBeginRegisterWorkQueueWithMMCSS = Win32::API::More->new('RTWorkQ',
    'int RtwqBeginRegisterWorkQueueWithMMCSS(DWORD workQueueId, LPCWSTR usageClass, DWORD dwTaskId, int lPriority, LPVOID doneCallback, LPVOID doneState)');
# my $ret = $RtwqBeginRegisterWorkQueueWithMMCSS->Call($workQueueId, $usageClass, $dwTaskId, $lPriority, $doneCallback, $doneState);
# workQueueId : DWORD -> DWORD
# usageClass : LPCWSTR -> LPCWSTR
# dwTaskId : DWORD -> DWORD
# lPriority : INT -> int
# doneCallback : IRtwqAsyncCallback* -> LPVOID
# doneState : IUnknown* -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型