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

RtwqSetLongRunning

関数
作業キューを長時間実行モードに設定する。
DLLRTWorkQ.dll呼出規約winapi対応OSWindows 8.1 以降

シグネチャ

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

HRESULT RtwqSetLongRunning(
    DWORD workQueueId,
    BOOL enable
);

パラメーター

名前方向説明
workQueueIdDWORDinワークキューの ID。
enableBOOLinアプリがヒントを送信する場合は true、それ以外の場合は false。既定値は false です。

戻り値の型: HRESULT

公式ドキュメント

このワークキューで長時間実行される処理が発生するというヒントをアプリが送信することを示します。

戻り値

この関数が成功した場合は 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 RtwqSetLongRunning(
    DWORD workQueueId,
    BOOL enable
);
[DllImport("RTWorkQ.dll", ExactSpelling = true)]
static extern int RtwqSetLongRunning(
    uint workQueueId,   // DWORD
    bool enable   // BOOL
);
<DllImport("RTWorkQ.dll", ExactSpelling:=True)>
Public Shared Function RtwqSetLongRunning(
    workQueueId As UInteger,   ' DWORD
    enable As Boolean   ' BOOL
) As Integer
End Function
' workQueueId : DWORD
' enable : BOOL
Declare PtrSafe Function RtwqSetLongRunning Lib "rtworkq" ( _
    ByVal workQueueId As Long, _
    ByVal enable As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

RtwqSetLongRunning = ctypes.windll.rtworkq.RtwqSetLongRunning
RtwqSetLongRunning.restype = ctypes.c_int
RtwqSetLongRunning.argtypes = [
    wintypes.DWORD,  # workQueueId : DWORD
    wintypes.BOOL,  # enable : BOOL
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('RTWorkQ.dll')
RtwqSetLongRunning = Fiddle::Function.new(
  lib['RtwqSetLongRunning'],
  [
    -Fiddle::TYPE_INT,  # workQueueId : DWORD
    Fiddle::TYPE_INT,  # enable : BOOL
  ],
  Fiddle::TYPE_INT)
#[link(name = "rtworkq")]
extern "system" {
    fn RtwqSetLongRunning(
        workQueueId: u32,  // DWORD
        enable: i32  // BOOL
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("RTWorkQ.dll")]
public static extern int RtwqSetLongRunning(uint workQueueId, bool enable);
"@
$api = Add-Type -MemberDefinition $sig -Name 'RTWorkQ_RtwqSetLongRunning' -Namespace Win32 -PassThru
# $api::RtwqSetLongRunning(workQueueId, enable)
#uselib "RTWorkQ.dll"
#func global RtwqSetLongRunning "RtwqSetLongRunning" sptr, sptr
; RtwqSetLongRunning workQueueId, enable   ; 戻り値は stat
; workQueueId : DWORD -> "sptr"
; enable : BOOL -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "RTWorkQ.dll"
#cfunc global RtwqSetLongRunning "RtwqSetLongRunning" int, int
; res = RtwqSetLongRunning(workQueueId, enable)
; workQueueId : DWORD -> "int"
; enable : BOOL -> "int"
; HRESULT RtwqSetLongRunning(DWORD workQueueId, BOOL enable)
#uselib "RTWorkQ.dll"
#cfunc global RtwqSetLongRunning "RtwqSetLongRunning" int, int
; res = RtwqSetLongRunning(workQueueId, enable)
; workQueueId : DWORD -> "int"
; enable : BOOL -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	rtworkq = windows.NewLazySystemDLL("RTWorkQ.dll")
	procRtwqSetLongRunning = rtworkq.NewProc("RtwqSetLongRunning")
)

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

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

typedef RtwqSetLongRunningNative = Int32 Function(Uint32, Int32);
typedef RtwqSetLongRunningDart = int Function(int, int);
final RtwqSetLongRunning = DynamicLibrary.open('RTWorkQ.dll')
    .lookupFunction<RtwqSetLongRunningNative, RtwqSetLongRunningDart>('RtwqSetLongRunning');
// workQueueId : DWORD -> Uint32
// enable : BOOL -> Int32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function RtwqSetLongRunning(
  workQueueId: DWORD;   // DWORD
  enable: BOOL   // BOOL
): Integer; stdcall;
  external 'RTWorkQ.dll' name 'RtwqSetLongRunning';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "RtwqSetLongRunning"
  c_RtwqSetLongRunning :: Word32 -> CInt -> IO Int32
-- workQueueId : DWORD -> Word32
-- enable : BOOL -> CInt
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let rtwqsetlongrunning =
  foreign "RtwqSetLongRunning"
    (uint32_t @-> int32_t @-> returning int32_t)
(* workQueueId : DWORD -> uint32_t *)
(* enable : BOOL -> int32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library rtworkq (t "RTWorkQ.dll"))
(cffi:use-foreign-library rtworkq)

(cffi:defcfun ("RtwqSetLongRunning" rtwq-set-long-running :convention :stdcall) :int32
  (work-queue-id :uint32)   ; DWORD
  (enable :int32))   ; BOOL
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $RtwqSetLongRunning = Win32::API::More->new('RTWorkQ',
    'int RtwqSetLongRunning(DWORD workQueueId, BOOL enable)');
# my $ret = $RtwqSetLongRunning->Call($workQueueId, $enable);
# workQueueId : DWORD -> DWORD
# enable : BOOL -> BOOL
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。