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

AvQuerySystemResponsiveness

関数
システムの応答性の値を問い合わせる。
DLLAVRT.dll呼出規約winapiSetLastErrorあり対応OSWindows Vista 以降

シグネチャ

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

BOOL AvQuerySystemResponsiveness(
    AVRT_TASK_HANDLE AvrtHandle,
    DWORD* SystemResponsivenessValue
);

パラメーター

名前方向説明
AvrtHandleAVRT_TASK_HANDLEinタスクのハンドル。このハンドルは、AvSetMmThreadCharacteristics 関数または AvSetMmMaxThreadCharacteristics 関数によって返されます。
SystemResponsivenessValueDWORD*outシステム応答性の値。この値は 10 から 100 パーセントの範囲を取ることができます。

戻り値の型: BOOL

公式ドキュメント

マルチメディアクラススケジューラサービスが使用するシステム応答性の設定を取得します。

戻り値

関数が成功した場合、戻り値は 0 以外の値です。

関数が失敗した場合、戻り値は 0 です。拡張エラー情報を取得するには、 GetLastError を呼び出します。

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

各言語での呼び出し定義

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

BOOL AvQuerySystemResponsiveness(
    AVRT_TASK_HANDLE AvrtHandle,
    DWORD* SystemResponsivenessValue
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("AVRT.dll", SetLastError = true, ExactSpelling = true)]
static extern bool AvQuerySystemResponsiveness(
    AVRT_TASK_HANDLE AvrtHandle,   // AVRT_TASK_HANDLE
    out uint SystemResponsivenessValue   // DWORD* out
);
<DllImport("AVRT.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function AvQuerySystemResponsiveness(
    AvrtHandle As AVRT_TASK_HANDLE,   ' AVRT_TASK_HANDLE
    <Out> ByRef SystemResponsivenessValue As UInteger   ' DWORD* out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' AvrtHandle : AVRT_TASK_HANDLE
' SystemResponsivenessValue : DWORD* out
Declare PtrSafe Function AvQuerySystemResponsiveness Lib "avrt" ( _
    ByVal AvrtHandle As LongPtr, _
    ByRef SystemResponsivenessValue As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

AvQuerySystemResponsiveness = ctypes.windll.avrt.AvQuerySystemResponsiveness
AvQuerySystemResponsiveness.restype = wintypes.BOOL
AvQuerySystemResponsiveness.argtypes = [
    AVRT_TASK_HANDLE,  # AvrtHandle : AVRT_TASK_HANDLE
    ctypes.POINTER(wintypes.DWORD),  # SystemResponsivenessValue : DWORD* out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('AVRT.dll')
AvQuerySystemResponsiveness = Fiddle::Function.new(
  lib['AvQuerySystemResponsiveness'],
  [
    Fiddle::TYPE_VOIDP,  # AvrtHandle : AVRT_TASK_HANDLE
    Fiddle::TYPE_VOIDP,  # SystemResponsivenessValue : DWORD* out
  ],
  Fiddle::TYPE_INT)
#[link(name = "avrt")]
extern "system" {
    fn AvQuerySystemResponsiveness(
        AvrtHandle: AVRT_TASK_HANDLE,  // AVRT_TASK_HANDLE
        SystemResponsivenessValue: *mut u32  // DWORD* out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("AVRT.dll", SetLastError = true)]
public static extern bool AvQuerySystemResponsiveness(AVRT_TASK_HANDLE AvrtHandle, out uint SystemResponsivenessValue);
"@
$api = Add-Type -MemberDefinition $sig -Name 'AVRT_AvQuerySystemResponsiveness' -Namespace Win32 -PassThru
# $api::AvQuerySystemResponsiveness(AvrtHandle, SystemResponsivenessValue)
#uselib "AVRT.dll"
#func global AvQuerySystemResponsiveness "AvQuerySystemResponsiveness" sptr, sptr
; AvQuerySystemResponsiveness AvrtHandle, varptr(SystemResponsivenessValue)   ; 戻り値は stat
; AvrtHandle : AVRT_TASK_HANDLE -> "sptr"
; SystemResponsivenessValue : DWORD* out -> "sptr"
; ※値渡し構造体は直接渡せません。intにパック、または var で構造体変数を渡してください。
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "AVRT.dll"
#cfunc global AvQuerySystemResponsiveness "AvQuerySystemResponsiveness" int, var
; res = AvQuerySystemResponsiveness(AvrtHandle, SystemResponsivenessValue)
; AvrtHandle : AVRT_TASK_HANDLE -> "int"
; SystemResponsivenessValue : DWORD* out -> "var"
; ※値渡し構造体は直接渡せません。intにパック、または var で構造体変数を渡してください。
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; BOOL AvQuerySystemResponsiveness(AVRT_TASK_HANDLE AvrtHandle, DWORD* SystemResponsivenessValue)
#uselib "AVRT.dll"
#cfunc global AvQuerySystemResponsiveness "AvQuerySystemResponsiveness" int, var
; res = AvQuerySystemResponsiveness(AvrtHandle, SystemResponsivenessValue)
; AvrtHandle : AVRT_TASK_HANDLE -> "int"
; SystemResponsivenessValue : DWORD* out -> "var"
; ※値渡し構造体は直接渡せません。intにパック、または var で構造体変数を渡してください。
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	avrt = windows.NewLazySystemDLL("AVRT.dll")
	procAvQuerySystemResponsiveness = avrt.NewProc("AvQuerySystemResponsiveness")
)

// AvrtHandle (AVRT_TASK_HANDLE), SystemResponsivenessValue (DWORD* out)
r1, _, err := procAvQuerySystemResponsiveness.Call(
	uintptr(AvrtHandle),
	uintptr(SystemResponsivenessValue),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function AvQuerySystemResponsiveness(
  AvrtHandle: AVRT_TASK_HANDLE;   // AVRT_TASK_HANDLE
  SystemResponsivenessValue: Pointer   // DWORD* out
): BOOL; stdcall;
  external 'AVRT.dll' name 'AvQuerySystemResponsiveness';
result := DllCall("AVRT\AvQuerySystemResponsiveness"
    , "Ptr", AvrtHandle   ; AVRT_TASK_HANDLE
    , "Ptr", SystemResponsivenessValue   ; DWORD* out
    , "Int")   ; return: BOOL
●AvQuerySystemResponsiveness(AvrtHandle, SystemResponsivenessValue) = DLL("AVRT.dll", "bool AvQuerySystemResponsiveness(void*, void*)")
# 呼び出し: AvQuerySystemResponsiveness(AvrtHandle, SystemResponsivenessValue)
# AvrtHandle : AVRT_TASK_HANDLE -> "void*"
# SystemResponsivenessValue : DWORD* out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

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

foreign import stdcall safe "AvQuerySystemResponsiveness"
  c_AvQuerySystemResponsiveness :: AVRT_TASK_HANDLE -> Ptr Word32 -> IO CInt
-- AvrtHandle : AVRT_TASK_HANDLE -> AVRT_TASK_HANDLE
-- SystemResponsivenessValue : DWORD* out -> Ptr Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
-- ※値渡し構造体は GHC FFI で直接渡せません。Ptr で渡すラッパ(C側)経由にしてください。
open Ctypes
open Foreign

let avquerysystemresponsiveness =
  foreign "AvQuerySystemResponsiveness"
    (AVRT_TASK_HANDLE @-> (ptr uint32_t) @-> returning int32_t)
(* AvrtHandle : AVRT_TASK_HANDLE -> AVRT_TASK_HANDLE *)
(* SystemResponsivenessValue : DWORD* out -> (ptr uint32_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library avrt (t "AVRT.dll"))
(cffi:use-foreign-library avrt)

(cffi:defcfun ("AvQuerySystemResponsiveness" av-query-system-responsiveness :convention :stdcall) :int32
  (avrt-handle (:struct avrt-task-handle))   ; AVRT_TASK_HANDLE
  (system-responsiveness-value :pointer))   ; DWORD* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $AvQuerySystemResponsiveness = Win32::API::More->new('AVRT',
    'BOOL AvQuerySystemResponsiveness(LPVOID AvrtHandle, LPVOID SystemResponsivenessValue)');
# my $ret = $AvQuerySystemResponsiveness->Call($AvrtHandle, $SystemResponsivenessValue);
# AvrtHandle : AVRT_TASK_HANDLE -> LPVOID
# SystemResponsivenessValue : DWORD* out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型