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

RtwqAddPeriodicCallback

関数
周期的に呼び出される定期コールバックを登録する。
DLLRTWorkQ.dll呼出規約winapi対応OSWindows 8.1 以降

シグネチャ

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

HRESULT RtwqAddPeriodicCallback(
    RTWQPERIODICCALLBACK Callback,
    IUnknown* context,
    DWORD* key   // optional
);

パラメーター

名前方向説明
CallbackRTWQPERIODICCALLBACKinコールバック関数へのポインター。
contextIUnknown*inIUnknown を実装する呼び出し側提供のオブジェクトへのポインター、または NULL。このパラメーターはコールバック関数に渡されます。
keyDWORD*outoptionalコールバックのキャンセルに使用できるキーを受け取ります。コールバックをキャンセルするには、RtwqRemovePeriodicCallback を呼び出し、このキーを dwKey パラメーターとして渡します。

戻り値の型: HRESULT

公式ドキュメント

一定の間隔で呼び出されるコールバック関数を設定します。(RtwqAddPeriodicCallback)

戻り値

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

RtwqAddPeriodicCallback = ctypes.windll.rtworkq.RtwqAddPeriodicCallback
RtwqAddPeriodicCallback.restype = ctypes.c_int
RtwqAddPeriodicCallback.argtypes = [
    ctypes.c_void_p,  # Callback : RTWQPERIODICCALLBACK
    ctypes.c_void_p,  # context : IUnknown*
    ctypes.POINTER(wintypes.DWORD),  # key : DWORD* optional, out
]
require 'fiddle'
require 'fiddle/import'

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

var (
	rtworkq = windows.NewLazySystemDLL("RTWorkQ.dll")
	procRtwqAddPeriodicCallback = rtworkq.NewProc("RtwqAddPeriodicCallback")
)

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

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

typedef RtwqAddPeriodicCallbackNative = Int32 Function(Pointer<Void>, Pointer<Void>, Pointer<Uint32>);
typedef RtwqAddPeriodicCallbackDart = int Function(Pointer<Void>, Pointer<Void>, Pointer<Uint32>);
final RtwqAddPeriodicCallback = DynamicLibrary.open('RTWorkQ.dll')
    .lookupFunction<RtwqAddPeriodicCallbackNative, RtwqAddPeriodicCallbackDart>('RtwqAddPeriodicCallback');
// Callback : RTWQPERIODICCALLBACK -> Pointer<Void>
// context : IUnknown* -> Pointer<Void>
// key : DWORD* optional, out -> Pointer<Uint32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function RtwqAddPeriodicCallback(
  Callback: Pointer;   // RTWQPERIODICCALLBACK
  context: Pointer;   // IUnknown*
  key: Pointer   // DWORD* optional, out
): Integer; stdcall;
  external 'RTWorkQ.dll' name 'RtwqAddPeriodicCallback';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "RtwqAddPeriodicCallback"
  c_RtwqAddPeriodicCallback :: Ptr () -> Ptr () -> Ptr Word32 -> IO Int32
-- Callback : RTWQPERIODICCALLBACK -> Ptr ()
-- context : IUnknown* -> Ptr ()
-- key : DWORD* optional, out -> Ptr Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let rtwqaddperiodiccallback =
  foreign "RtwqAddPeriodicCallback"
    ((ptr void) @-> (ptr void) @-> (ptr uint32_t) @-> returning int32_t)
(* Callback : RTWQPERIODICCALLBACK -> (ptr void) *)
(* context : IUnknown* -> (ptr void) *)
(* key : DWORD* optional, 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 ("RtwqAddPeriodicCallback" rtwq-add-periodic-callback :convention :stdcall) :int32
  (callback :pointer)   ; RTWQPERIODICCALLBACK
  (context :pointer)   ; IUnknown*
  (key :pointer))   ; DWORD* optional, out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $RtwqAddPeriodicCallback = Win32::API::More->new('RTWorkQ',
    'int RtwqAddPeriodicCallback(LPVOID Callback, LPVOID context, LPVOID key)');
# my $ret = $RtwqAddPeriodicCallback->Call($Callback, $context, $key);
# Callback : RTWQPERIODICCALLBACK -> LPVOID
# context : IUnknown* -> LPVOID
# key : DWORD* optional, out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# コールバック(関数ポインタ)は Perl sub を直接渡せません。Win32::API::Callback を使用してください。

関連項目

使用する型