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

RtwqLockSharedWorkQueue

関数
指定の使用クラスと優先度で共有作業キューをロックして取得する。
DLLRTWorkQ.dll呼出規約winapi対応OSWindows 8.1 以降

シグネチャ

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

HRESULT RtwqLockSharedWorkQueue(
    LPCWSTR usageClass,
    INT basePriority,
    DWORD* taskId,
    DWORD* id
);

パラメーター

名前方向説明
usageClassLPCWSTRinMultimedia Class Scheduler Service (MMCSS) タスクの名前。
basePriorityINTin作業キュー スレッドの基本優先度。通常優先度のキューを使用する場合(usageClass="")は、値 0 を渡す必要があります。
taskIdDWORD*inoutMMCSS タスク識別子。入力時には、既存の MMCSS タスク グループ ID を指定するか、新しいタスク グループを作成するために値 0 を使用します。通常優先度のキューを使用する場合(usageClass="")は、NULL を渡す必要があります。出力時には、実際のタスク グループ ID を受け取ります。
idDWORD*out新しい作業キューの識別子を受け取ります。作業項目をキューに登録する際にこの識別子を使用します。

戻り値の型: HRESULT

公式ドキュメント

共有作業キューを取得してロックします。(RtwqLockSharedWorkQueue)

戻り値

この関数が成功した場合は 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 RtwqLockSharedWorkQueue(
    LPCWSTR usageClass,
    INT basePriority,
    DWORD* taskId,
    DWORD* id
);
[DllImport("RTWorkQ.dll", ExactSpelling = true)]
static extern int RtwqLockSharedWorkQueue(
    [MarshalAs(UnmanagedType.LPWStr)] string usageClass,   // LPCWSTR
    int basePriority,   // INT
    ref uint taskId,   // DWORD* in/out
    out uint id   // DWORD* out
);
<DllImport("RTWorkQ.dll", ExactSpelling:=True)>
Public Shared Function RtwqLockSharedWorkQueue(
    <MarshalAs(UnmanagedType.LPWStr)> usageClass As String,   ' LPCWSTR
    basePriority As Integer,   ' INT
    ByRef taskId As UInteger,   ' DWORD* in/out
    <Out> ByRef id As UInteger   ' DWORD* out
) As Integer
End Function
' usageClass : LPCWSTR
' basePriority : INT
' taskId : DWORD* in/out
' id : DWORD* out
Declare PtrSafe Function RtwqLockSharedWorkQueue Lib "rtworkq" ( _
    ByVal usageClass As LongPtr, _
    ByVal basePriority As Long, _
    ByRef taskId As Long, _
    ByRef id As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

RtwqLockSharedWorkQueue = ctypes.windll.rtworkq.RtwqLockSharedWorkQueue
RtwqLockSharedWorkQueue.restype = ctypes.c_int
RtwqLockSharedWorkQueue.argtypes = [
    wintypes.LPCWSTR,  # usageClass : LPCWSTR
    ctypes.c_int,  # basePriority : INT
    ctypes.POINTER(wintypes.DWORD),  # taskId : DWORD* in/out
    ctypes.POINTER(wintypes.DWORD),  # id : DWORD* out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('RTWorkQ.dll')
RtwqLockSharedWorkQueue = Fiddle::Function.new(
  lib['RtwqLockSharedWorkQueue'],
  [
    Fiddle::TYPE_VOIDP,  # usageClass : LPCWSTR
    Fiddle::TYPE_INT,  # basePriority : INT
    Fiddle::TYPE_VOIDP,  # taskId : DWORD* in/out
    Fiddle::TYPE_VOIDP,  # id : DWORD* out
  ],
  Fiddle::TYPE_INT)
#[link(name = "rtworkq")]
extern "system" {
    fn RtwqLockSharedWorkQueue(
        usageClass: *const u16,  // LPCWSTR
        basePriority: i32,  // INT
        taskId: *mut u32,  // DWORD* in/out
        id: *mut u32  // DWORD* out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("RTWorkQ.dll")]
public static extern int RtwqLockSharedWorkQueue([MarshalAs(UnmanagedType.LPWStr)] string usageClass, int basePriority, ref uint taskId, out uint id);
"@
$api = Add-Type -MemberDefinition $sig -Name 'RTWorkQ_RtwqLockSharedWorkQueue' -Namespace Win32 -PassThru
# $api::RtwqLockSharedWorkQueue(usageClass, basePriority, taskId, id)
#uselib "RTWorkQ.dll"
#func global RtwqLockSharedWorkQueue "RtwqLockSharedWorkQueue" sptr, sptr, sptr, sptr
; RtwqLockSharedWorkQueue usageClass, basePriority, varptr(taskId), varptr(id)   ; 戻り値は stat
; usageClass : LPCWSTR -> "sptr"
; basePriority : INT -> "sptr"
; taskId : DWORD* in/out -> "sptr"
; id : DWORD* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "RTWorkQ.dll"
#cfunc global RtwqLockSharedWorkQueue "RtwqLockSharedWorkQueue" wstr, int, var, var
; res = RtwqLockSharedWorkQueue(usageClass, basePriority, taskId, id)
; usageClass : LPCWSTR -> "wstr"
; basePriority : INT -> "int"
; taskId : DWORD* in/out -> "var"
; id : DWORD* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; HRESULT RtwqLockSharedWorkQueue(LPCWSTR usageClass, INT basePriority, DWORD* taskId, DWORD* id)
#uselib "RTWorkQ.dll"
#cfunc global RtwqLockSharedWorkQueue "RtwqLockSharedWorkQueue" wstr, int, var, var
; res = RtwqLockSharedWorkQueue(usageClass, basePriority, taskId, id)
; usageClass : LPCWSTR -> "wstr"
; basePriority : INT -> "int"
; taskId : DWORD* in/out -> "var"
; id : DWORD* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	rtworkq = windows.NewLazySystemDLL("RTWorkQ.dll")
	procRtwqLockSharedWorkQueue = rtworkq.NewProc("RtwqLockSharedWorkQueue")
)

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

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

typedef RtwqLockSharedWorkQueueNative = Int32 Function(Pointer<Utf16>, Int32, Pointer<Uint32>, Pointer<Uint32>);
typedef RtwqLockSharedWorkQueueDart = int Function(Pointer<Utf16>, int, Pointer<Uint32>, Pointer<Uint32>);
final RtwqLockSharedWorkQueue = DynamicLibrary.open('RTWorkQ.dll')
    .lookupFunction<RtwqLockSharedWorkQueueNative, RtwqLockSharedWorkQueueDart>('RtwqLockSharedWorkQueue');
// usageClass : LPCWSTR -> Pointer<Utf16>
// basePriority : INT -> Int32
// taskId : DWORD* in/out -> Pointer<Uint32>
// id : DWORD* out -> Pointer<Uint32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function RtwqLockSharedWorkQueue(
  usageClass: PWideChar;   // LPCWSTR
  basePriority: Integer;   // INT
  taskId: Pointer;   // DWORD* in/out
  id: Pointer   // DWORD* out
): Integer; stdcall;
  external 'RTWorkQ.dll' name 'RtwqLockSharedWorkQueue';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "RtwqLockSharedWorkQueue"
  c_RtwqLockSharedWorkQueue :: CWString -> Int32 -> Ptr Word32 -> Ptr Word32 -> IO Int32
-- usageClass : LPCWSTR -> CWString
-- basePriority : INT -> Int32
-- taskId : DWORD* in/out -> Ptr Word32
-- id : DWORD* out -> Ptr Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let rtwqlocksharedworkqueue =
  foreign "RtwqLockSharedWorkQueue"
    ((ptr uint16_t) @-> int32_t @-> (ptr uint32_t) @-> (ptr uint32_t) @-> returning int32_t)
(* usageClass : LPCWSTR -> (ptr uint16_t) *)
(* basePriority : INT -> int32_t *)
(* taskId : DWORD* in/out -> (ptr uint32_t) *)
(* id : DWORD* out -> (ptr uint32_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library rtworkq (t "RTWorkQ.dll"))
(cffi:use-foreign-library rtworkq)

(cffi:defcfun ("RtwqLockSharedWorkQueue" rtwq-lock-shared-work-queue :convention :stdcall) :int32
  (usage-class (:string :encoding :utf-16le))   ; LPCWSTR
  (base-priority :int32)   ; INT
  (task-id :pointer)   ; DWORD* in/out
  (id :pointer))   ; DWORD* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $RtwqLockSharedWorkQueue = Win32::API::More->new('RTWorkQ',
    'int RtwqLockSharedWorkQueue(LPCWSTR usageClass, int basePriority, LPVOID taskId, LPVOID id)');
# my $ret = $RtwqLockSharedWorkQueue->Call($usageClass, $basePriority, $taskId, $id);
# usageClass : LPCWSTR -> LPCWSTR
# basePriority : INT -> int
# taskId : DWORD* in/out -> LPVOID
# id : DWORD* out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。