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

RtwqGetWorkQueueMMCSSClass

関数
作業キューに関連付けられたMMCSSクラス名を取得する。
DLLRTWorkQ.dll呼出規約winapi対応OSWindows 8.1 以降

シグネチャ

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

HRESULT RtwqGetWorkQueueMMCSSClass(
    DWORD workQueueId,
    LPWSTR usageClass,   // optional
    DWORD* usageClassLength
);

パラメーター

名前方向説明
workQueueIdDWORDinワークキューの識別子です。この識別子は RtwqAllocateWorkQueue 関数によって取得します。
usageClassLPWSTRoutoptionalMMCSS クラスの名前を受け取るバッファーへのポインターです。このパラメーターは NULL にできます。
usageClassLengthDWORD*inout入力時には、usageClass バッファーのサイズを文字数で指定します。出力時には、必要なバッファーのサイズを文字数で受け取ります。このサイズには終端の null 文字が含まれます。

戻り値の型: HRESULT

公式ドキュメント

このワークキューに現在関連付けられている Multimedia Class Scheduler Service (MMCSS) クラスを取得します。(RtwqGetWorkQueueMMCSSClass)

戻り値

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

RtwqGetWorkQueueMMCSSClass = ctypes.windll.rtworkq.RtwqGetWorkQueueMMCSSClass
RtwqGetWorkQueueMMCSSClass.restype = ctypes.c_int
RtwqGetWorkQueueMMCSSClass.argtypes = [
    wintypes.DWORD,  # workQueueId : DWORD
    wintypes.LPWSTR,  # usageClass : LPWSTR optional, out
    ctypes.POINTER(wintypes.DWORD),  # usageClassLength : DWORD* in/out
]
require 'fiddle'
require 'fiddle/import'

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

var (
	rtworkq = windows.NewLazySystemDLL("RTWorkQ.dll")
	procRtwqGetWorkQueueMMCSSClass = rtworkq.NewProc("RtwqGetWorkQueueMMCSSClass")
)

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

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

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

foreign import stdcall safe "RtwqGetWorkQueueMMCSSClass"
  c_RtwqGetWorkQueueMMCSSClass :: Word32 -> CWString -> Ptr Word32 -> IO Int32
-- workQueueId : DWORD -> Word32
-- usageClass : LPWSTR optional, out -> CWString
-- usageClassLength : DWORD* in/out -> Ptr Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let rtwqgetworkqueuemmcssclass =
  foreign "RtwqGetWorkQueueMMCSSClass"
    (uint32_t @-> (ptr uint16_t) @-> (ptr uint32_t) @-> returning int32_t)
(* workQueueId : DWORD -> uint32_t *)
(* usageClass : LPWSTR optional, out -> (ptr uint16_t) *)
(* usageClassLength : DWORD* in/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 ("RtwqGetWorkQueueMMCSSClass" rtwq-get-work-queue-mmcssclass :convention :stdcall) :int32
  (work-queue-id :uint32)   ; DWORD
  (usage-class :pointer)   ; LPWSTR optional, out
  (usage-class-length :pointer))   ; DWORD* in/out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $RtwqGetWorkQueueMMCSSClass = Win32::API::More->new('RTWorkQ',
    'int RtwqGetWorkQueueMMCSSClass(DWORD workQueueId, LPWSTR usageClass, LPVOID usageClassLength)');
# my $ret = $RtwqGetWorkQueueMMCSSClass->Call($workQueueId, $usageClass, $usageClassLength);
# workQueueId : DWORD -> DWORD
# usageClass : LPWSTR optional, out -> LPWSTR
# usageClassLength : DWORD* in/out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。