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

RtwqBeginUnregisterWorkQueueWithMMCSS

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

シグネチャ

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

HRESULT RtwqBeginUnregisterWorkQueueWithMMCSS(
    DWORD workQueueId,
    IRtwqAsyncCallback* doneCallback,
    IUnknown* doneState
);

パラメーター

名前方向説明
workQueueIdDWORDin作業キューの識別子。プライベート作業キューの場合、この識別子は RtwqAllocateWorkQueue 関数によって返されます。
doneCallbackIRtwqAsyncCallback*inコールバックオブジェクトの IRtwqAsyncCallback インターフェイスへのポインター。呼び出し元はこのインターフェイスを実装する必要があります。
doneStateIUnknown*in呼び出し元が定義する状態オブジェクトの IUnknown インターフェイスへのポインター。このパラメーターは NULL でもかまいません。このオブジェクトは状態情報を保持するために使用できます。オブジェクトは、コールバックが呼び出されるときに呼び出し元へ返されます。

戻り値の型: HRESULT

公式ドキュメント

作業キューを Multimedia Class Scheduler Service (MMCSS) タスクから登録解除します。(RtwqBeginUnregisterWorkQueueWithMMCSS)

戻り値

この関数が成功した場合は 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 RtwqBeginUnregisterWorkQueueWithMMCSS(
    DWORD workQueueId,
    IRtwqAsyncCallback* doneCallback,
    IUnknown* doneState
);
[DllImport("RTWorkQ.dll", ExactSpelling = true)]
static extern int RtwqBeginUnregisterWorkQueueWithMMCSS(
    uint workQueueId,   // DWORD
    IntPtr doneCallback,   // IRtwqAsyncCallback*
    IntPtr doneState   // IUnknown*
);
<DllImport("RTWorkQ.dll", ExactSpelling:=True)>
Public Shared Function RtwqBeginUnregisterWorkQueueWithMMCSS(
    workQueueId As UInteger,   ' DWORD
    doneCallback As IntPtr,   ' IRtwqAsyncCallback*
    doneState As IntPtr   ' IUnknown*
) As Integer
End Function
' workQueueId : DWORD
' doneCallback : IRtwqAsyncCallback*
' doneState : IUnknown*
Declare PtrSafe Function RtwqBeginUnregisterWorkQueueWithMMCSS Lib "rtworkq" ( _
    ByVal workQueueId 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

RtwqBeginUnregisterWorkQueueWithMMCSS = ctypes.windll.rtworkq.RtwqBeginUnregisterWorkQueueWithMMCSS
RtwqBeginUnregisterWorkQueueWithMMCSS.restype = ctypes.c_int
RtwqBeginUnregisterWorkQueueWithMMCSS.argtypes = [
    wintypes.DWORD,  # workQueueId : DWORD
    ctypes.c_void_p,  # doneCallback : IRtwqAsyncCallback*
    ctypes.c_void_p,  # doneState : IUnknown*
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('RTWorkQ.dll')
RtwqBeginUnregisterWorkQueueWithMMCSS = Fiddle::Function.new(
  lib['RtwqBeginUnregisterWorkQueueWithMMCSS'],
  [
    -Fiddle::TYPE_INT,  # workQueueId : DWORD
    Fiddle::TYPE_VOIDP,  # doneCallback : IRtwqAsyncCallback*
    Fiddle::TYPE_VOIDP,  # doneState : IUnknown*
  ],
  Fiddle::TYPE_INT)
#[link(name = "rtworkq")]
extern "system" {
    fn RtwqBeginUnregisterWorkQueueWithMMCSS(
        workQueueId: u32,  // DWORD
        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 RtwqBeginUnregisterWorkQueueWithMMCSS(uint workQueueId, IntPtr doneCallback, IntPtr doneState);
"@
$api = Add-Type -MemberDefinition $sig -Name 'RTWorkQ_RtwqBeginUnregisterWorkQueueWithMMCSS' -Namespace Win32 -PassThru
# $api::RtwqBeginUnregisterWorkQueueWithMMCSS(workQueueId, doneCallback, doneState)
#uselib "RTWorkQ.dll"
#func global RtwqBeginUnregisterWorkQueueWithMMCSS "RtwqBeginUnregisterWorkQueueWithMMCSS" sptr, sptr, sptr
; RtwqBeginUnregisterWorkQueueWithMMCSS workQueueId, doneCallback, doneState   ; 戻り値は stat
; workQueueId : DWORD -> "sptr"
; doneCallback : IRtwqAsyncCallback* -> "sptr"
; doneState : IUnknown* -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "RTWorkQ.dll"
#cfunc global RtwqBeginUnregisterWorkQueueWithMMCSS "RtwqBeginUnregisterWorkQueueWithMMCSS" int, sptr, sptr
; res = RtwqBeginUnregisterWorkQueueWithMMCSS(workQueueId, doneCallback, doneState)
; workQueueId : DWORD -> "int"
; doneCallback : IRtwqAsyncCallback* -> "sptr"
; doneState : IUnknown* -> "sptr"
; HRESULT RtwqBeginUnregisterWorkQueueWithMMCSS(DWORD workQueueId, IRtwqAsyncCallback* doneCallback, IUnknown* doneState)
#uselib "RTWorkQ.dll"
#cfunc global RtwqBeginUnregisterWorkQueueWithMMCSS "RtwqBeginUnregisterWorkQueueWithMMCSS" int, intptr, intptr
; res = RtwqBeginUnregisterWorkQueueWithMMCSS(workQueueId, doneCallback, doneState)
; workQueueId : DWORD -> "int"
; doneCallback : IRtwqAsyncCallback* -> "intptr"
; doneState : IUnknown* -> "intptr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	rtworkq = windows.NewLazySystemDLL("RTWorkQ.dll")
	procRtwqBeginUnregisterWorkQueueWithMMCSS = rtworkq.NewProc("RtwqBeginUnregisterWorkQueueWithMMCSS")
)

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

extern "rtworkq" fn RtwqBeginUnregisterWorkQueueWithMMCSS(
    workQueueId: u32, // DWORD
    doneCallback: ?*anyopaque, // IRtwqAsyncCallback*
    doneState: ?*anyopaque // IUnknown*
) callconv(std.os.windows.WINAPI) i32;
proc RtwqBeginUnregisterWorkQueueWithMMCSS(
    workQueueId: uint32,  # DWORD
    doneCallback: pointer,  # IRtwqAsyncCallback*
    doneState: pointer  # IUnknown*
): int32 {.importc: "RtwqBeginUnregisterWorkQueueWithMMCSS", stdcall, dynlib: "RTWorkQ.dll".}
pragma(lib, "rtworkq");
extern(Windows)
int RtwqBeginUnregisterWorkQueueWithMMCSS(
    uint workQueueId,   // DWORD
    void* doneCallback,   // IRtwqAsyncCallback*
    void* doneState   // IUnknown*
);
ccall((:RtwqBeginUnregisterWorkQueueWithMMCSS, "RTWorkQ.dll"), stdcall, Int32,
      (UInt32, Ptr{Cvoid}, Ptr{Cvoid}),
      workQueueId, doneCallback, doneState)
# workQueueId : DWORD -> UInt32
# doneCallback : IRtwqAsyncCallback* -> Ptr{Cvoid}
# doneState : IUnknown* -> Ptr{Cvoid}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t RtwqBeginUnregisterWorkQueueWithMMCSS(
    uint32_t workQueueId,
    void* doneCallback,
    void* doneState);
]]
local rtworkq = ffi.load("rtworkq")
-- rtworkq.RtwqBeginUnregisterWorkQueueWithMMCSS(workQueueId, doneCallback, doneState)
-- workQueueId : DWORD
-- doneCallback : IRtwqAsyncCallback*
-- doneState : IUnknown*
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('RTWorkQ.dll');
const RtwqBeginUnregisterWorkQueueWithMMCSS = lib.func('__stdcall', 'RtwqBeginUnregisterWorkQueueWithMMCSS', 'int32_t', ['uint32_t', 'void *', 'void *']);
// RtwqBeginUnregisterWorkQueueWithMMCSS(workQueueId, doneCallback, doneState)
// workQueueId : DWORD -> 'uint32_t'
// doneCallback : IRtwqAsyncCallback* -> 'void *'
// doneState : IUnknown* -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("RTWorkQ.dll", {
  RtwqBeginUnregisterWorkQueueWithMMCSS: { parameters: ["u32", "pointer", "pointer"], result: "i32" },
});
// lib.symbols.RtwqBeginUnregisterWorkQueueWithMMCSS(workQueueId, doneCallback, doneState)
// workQueueId : DWORD -> "u32"
// doneCallback : IRtwqAsyncCallback* -> "pointer"
// doneState : IUnknown* -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t RtwqBeginUnregisterWorkQueueWithMMCSS(
    uint32_t workQueueId,
    void* doneCallback,
    void* doneState);
C, "RTWorkQ.dll");
// $ffi->RtwqBeginUnregisterWorkQueueWithMMCSS(workQueueId, doneCallback, doneState);
// workQueueId : DWORD
// 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 RtwqBeginUnregisterWorkQueueWithMMCSS(
        int workQueueId,   // DWORD
        Pointer doneCallback,   // IRtwqAsyncCallback*
        Pointer doneState   // IUnknown*
    );
}
@[Link("rtworkq")]
lib LibRTWorkQ
  fun RtwqBeginUnregisterWorkQueueWithMMCSS = RtwqBeginUnregisterWorkQueueWithMMCSS(
    workQueueId : UInt32,   # DWORD
    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 RtwqBeginUnregisterWorkQueueWithMMCSSNative = Int32 Function(Uint32, Pointer<Void>, Pointer<Void>);
typedef RtwqBeginUnregisterWorkQueueWithMMCSSDart = int Function(int, Pointer<Void>, Pointer<Void>);
final RtwqBeginUnregisterWorkQueueWithMMCSS = DynamicLibrary.open('RTWorkQ.dll')
    .lookupFunction<RtwqBeginUnregisterWorkQueueWithMMCSSNative, RtwqBeginUnregisterWorkQueueWithMMCSSDart>('RtwqBeginUnregisterWorkQueueWithMMCSS');
// workQueueId : DWORD -> Uint32
// doneCallback : IRtwqAsyncCallback* -> Pointer<Void>
// doneState : IUnknown* -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function RtwqBeginUnregisterWorkQueueWithMMCSS(
  workQueueId: DWORD;   // DWORD
  doneCallback: Pointer;   // IRtwqAsyncCallback*
  doneState: Pointer   // IUnknown*
): Integer; stdcall;
  external 'RTWorkQ.dll' name 'RtwqBeginUnregisterWorkQueueWithMMCSS';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

let rtwqbeginunregisterworkqueuewithmmcss =
  foreign "RtwqBeginUnregisterWorkQueueWithMMCSS"
    (uint32_t @-> (ptr void) @-> (ptr void) @-> returning int32_t)
(* workQueueId : DWORD -> uint32_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 ("RtwqBeginUnregisterWorkQueueWithMMCSS" rtwq-begin-unregister-work-queue-with-mmcss :convention :stdcall) :int32
  (work-queue-id :uint32)   ; DWORD
  (done-callback :pointer)   ; IRtwqAsyncCallback*
  (done-state :pointer))   ; IUnknown*
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $RtwqBeginUnregisterWorkQueueWithMMCSS = Win32::API::More->new('RTWorkQ',
    'int RtwqBeginUnregisterWorkQueueWithMMCSS(DWORD workQueueId, LPVOID doneCallback, LPVOID doneState)');
# my $ret = $RtwqBeginUnregisterWorkQueueWithMMCSS->Call($workQueueId, $doneCallback, $doneState);
# workQueueId : DWORD -> DWORD
# doneCallback : IRtwqAsyncCallback* -> LPVOID
# doneState : IUnknown* -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型