ホーム › System.Threading › TrySubmitThreadpoolCallback
TrySubmitThreadpoolCallback
関数簡易コールバックをスレッドプールに要求する。
シグネチャ
// KERNEL32.dll
#include <windows.h>
BOOL TrySubmitThreadpoolCallback(
PTP_SIMPLE_CALLBACK pfns,
void* pv, // optional
TP_CALLBACK_ENVIRON_V3* pcbe // optional
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| pfns | PTP_SIMPLE_CALLBACK | in | コールバック関数。詳細については、SimpleCallback を参照してください。 |
| pv | void* | inoutoptional | コールバック関数に渡す、アプリケーション定義の省略可能なデータ。 |
| pcbe | TP_CALLBACK_ENVIRON_V3* | inoptional | コールバック関数を実行する環境を定義する TP_CALLBACK_ENVIRON 構造体へのポインター。この関数を呼び出す前に、InitializeThreadpoolEnvironment 関数を使用して構造体を初期化してください。 このパラメーターが NULL の場合、コールバックは既定のコールバック環境で実行されます。詳細については、InitializeThreadpoolEnvironment を参照してください。 |
戻り値の型: BOOL
公式ドキュメント
スレッドプールのワーカースレッドが指定したコールバック関数を呼び出すよう要求します。
戻り値
関数が成功した場合は TRUE を返します。
関数が失敗した場合は FALSE を返します。拡張エラー情報を取得するには、GetLastError を呼び出してください。
解説(Remarks)
この関数を使用するアプリケーションをコンパイルするには、_WIN32_WINNT を 0x0600 以上として定義してください。
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// KERNEL32.dll
#include <windows.h>
BOOL TrySubmitThreadpoolCallback(
PTP_SIMPLE_CALLBACK pfns,
void* pv, // optional
TP_CALLBACK_ENVIRON_V3* pcbe // optional
);[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool TrySubmitThreadpoolCallback(
IntPtr pfns, // PTP_SIMPLE_CALLBACK
IntPtr pv, // void* optional, in/out
IntPtr pcbe // TP_CALLBACK_ENVIRON_V3* optional
);<DllImport("KERNEL32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function TrySubmitThreadpoolCallback(
pfns As IntPtr, ' PTP_SIMPLE_CALLBACK
pv As IntPtr, ' void* optional, in/out
pcbe As IntPtr ' TP_CALLBACK_ENVIRON_V3* optional
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function' pfns : PTP_SIMPLE_CALLBACK
' pv : void* optional, in/out
' pcbe : TP_CALLBACK_ENVIRON_V3* optional
Declare PtrSafe Function TrySubmitThreadpoolCallback Lib "kernel32" ( _
ByVal pfns As LongPtr, _
ByVal pv As LongPtr, _
ByVal pcbe As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。import ctypes
from ctypes import wintypes
TrySubmitThreadpoolCallback = ctypes.windll.kernel32.TrySubmitThreadpoolCallback
TrySubmitThreadpoolCallback.restype = wintypes.BOOL
TrySubmitThreadpoolCallback.argtypes = [
ctypes.c_void_p, # pfns : PTP_SIMPLE_CALLBACK
ctypes.POINTER(None), # pv : void* optional, in/out
ctypes.c_void_p, # pcbe : TP_CALLBACK_ENVIRON_V3* optional
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('KERNEL32.dll')
TrySubmitThreadpoolCallback = Fiddle::Function.new(
lib['TrySubmitThreadpoolCallback'],
[
Fiddle::TYPE_VOIDP, # pfns : PTP_SIMPLE_CALLBACK
Fiddle::TYPE_VOIDP, # pv : void* optional, in/out
Fiddle::TYPE_VOIDP, # pcbe : TP_CALLBACK_ENVIRON_V3* optional
],
Fiddle::TYPE_INT)#[link(name = "kernel32")]
extern "system" {
fn TrySubmitThreadpoolCallback(
pfns: *const core::ffi::c_void, // PTP_SIMPLE_CALLBACK
pv: *mut (), // void* optional, in/out
pcbe: *mut TP_CALLBACK_ENVIRON_V3 // TP_CALLBACK_ENVIRON_V3* optional
) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", SetLastError = true)]
public static extern bool TrySubmitThreadpoolCallback(IntPtr pfns, IntPtr pv, IntPtr pcbe);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_TrySubmitThreadpoolCallback' -Namespace Win32 -PassThru
# $api::TrySubmitThreadpoolCallback(pfns, pv, pcbe)#uselib "KERNEL32.dll"
#func global TrySubmitThreadpoolCallback "TrySubmitThreadpoolCallback" sptr, sptr, sptr
; TrySubmitThreadpoolCallback pfns, pv, varptr(pcbe) ; 戻り値は stat
; pfns : PTP_SIMPLE_CALLBACK -> "sptr"
; pv : void* optional, in/out -> "sptr"
; pcbe : TP_CALLBACK_ENVIRON_V3* optional -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。出力引数:
#uselib "KERNEL32.dll" #cfunc global TrySubmitThreadpoolCallback "TrySubmitThreadpoolCallback" sptr, sptr, var ; res = TrySubmitThreadpoolCallback(pfns, pv, pcbe) ; pfns : PTP_SIMPLE_CALLBACK -> "sptr" ; pv : void* optional, in/out -> "sptr" ; pcbe : TP_CALLBACK_ENVIRON_V3* optional -> "var" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "KERNEL32.dll" #cfunc global TrySubmitThreadpoolCallback "TrySubmitThreadpoolCallback" sptr, sptr, sptr ; res = TrySubmitThreadpoolCallback(pfns, pv, varptr(pcbe)) ; pfns : PTP_SIMPLE_CALLBACK -> "sptr" ; pv : void* optional, in/out -> "sptr" ; pcbe : TP_CALLBACK_ENVIRON_V3* optional -> "sptr" ; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
出力引数:
; BOOL TrySubmitThreadpoolCallback(PTP_SIMPLE_CALLBACK pfns, void* pv, TP_CALLBACK_ENVIRON_V3* pcbe) #uselib "KERNEL32.dll" #cfunc global TrySubmitThreadpoolCallback "TrySubmitThreadpoolCallback" intptr, intptr, var ; res = TrySubmitThreadpoolCallback(pfns, pv, pcbe) ; pfns : PTP_SIMPLE_CALLBACK -> "intptr" ; pv : void* optional, in/out -> "intptr" ; pcbe : TP_CALLBACK_ENVIRON_V3* optional -> "var" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。; BOOL TrySubmitThreadpoolCallback(PTP_SIMPLE_CALLBACK pfns, void* pv, TP_CALLBACK_ENVIRON_V3* pcbe) #uselib "KERNEL32.dll" #cfunc global TrySubmitThreadpoolCallback "TrySubmitThreadpoolCallback" intptr, intptr, intptr ; res = TrySubmitThreadpoolCallback(pfns, pv, varptr(pcbe)) ; pfns : PTP_SIMPLE_CALLBACK -> "intptr" ; pv : void* optional, in/out -> "intptr" ; pcbe : TP_CALLBACK_ENVIRON_V3* optional -> "intptr" ; ※出力/バッファ引数はポインタ方式(token=intptr / 呼び出しは varptr(変数))。
import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
procTrySubmitThreadpoolCallback = kernel32.NewProc("TrySubmitThreadpoolCallback")
)
// pfns (PTP_SIMPLE_CALLBACK), pv (void* optional, in/out), pcbe (TP_CALLBACK_ENVIRON_V3* optional)
r1, _, err := procTrySubmitThreadpoolCallback.Call(
uintptr(pfns),
uintptr(pv),
uintptr(pcbe),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // BOOLfunction TrySubmitThreadpoolCallback(
pfns: Pointer; // PTP_SIMPLE_CALLBACK
pv: Pointer; // void* optional, in/out
pcbe: Pointer // TP_CALLBACK_ENVIRON_V3* optional
): BOOL; stdcall;
external 'KERNEL32.dll' name 'TrySubmitThreadpoolCallback';result := DllCall("KERNEL32\TrySubmitThreadpoolCallback"
, "Ptr", pfns ; PTP_SIMPLE_CALLBACK
, "Ptr", pv ; void* optional, in/out
, "Ptr", pcbe ; TP_CALLBACK_ENVIRON_V3* optional
, "Int") ; return: BOOL●TrySubmitThreadpoolCallback(pfns, pv, pcbe) = DLL("KERNEL32.dll", "bool TrySubmitThreadpoolCallback(void*, void*, void*)")
# 呼び出し: TrySubmitThreadpoolCallback(pfns, pv, pcbe)
# pfns : PTP_SIMPLE_CALLBACK -> "void*"
# pv : void* optional, in/out -> "void*"
# pcbe : TP_CALLBACK_ENVIRON_V3* optional -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "kernel32" fn TrySubmitThreadpoolCallback(
pfns: ?*anyopaque, // PTP_SIMPLE_CALLBACK
pv: ?*anyopaque, // void* optional, in/out
pcbe: [*c]TP_CALLBACK_ENVIRON_V3 // TP_CALLBACK_ENVIRON_V3* optional
) callconv(std.os.windows.WINAPI) i32;proc TrySubmitThreadpoolCallback(
pfns: pointer, # PTP_SIMPLE_CALLBACK
pv: pointer, # void* optional, in/out
pcbe: ptr TP_CALLBACK_ENVIRON_V3 # TP_CALLBACK_ENVIRON_V3* optional
): int32 {.importc: "TrySubmitThreadpoolCallback", stdcall, dynlib: "KERNEL32.dll".}pragma(lib, "kernel32");
extern(Windows)
int TrySubmitThreadpoolCallback(
void* pfns, // PTP_SIMPLE_CALLBACK
void* pv, // void* optional, in/out
TP_CALLBACK_ENVIRON_V3* pcbe // TP_CALLBACK_ENVIRON_V3* optional
);ccall((:TrySubmitThreadpoolCallback, "KERNEL32.dll"), stdcall, Int32,
(Ptr{Cvoid}, Ptr{Cvoid}, Ptr{TP_CALLBACK_ENVIRON_V3}),
pfns, pv, pcbe)
# pfns : PTP_SIMPLE_CALLBACK -> Ptr{Cvoid}
# pv : void* optional, in/out -> Ptr{Cvoid}
# pcbe : TP_CALLBACK_ENVIRON_V3* optional -> Ptr{TP_CALLBACK_ENVIRON_V3}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
int32_t TrySubmitThreadpoolCallback(
void* pfns,
void* pv,
void* pcbe);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.TrySubmitThreadpoolCallback(pfns, pv, pcbe)
-- pfns : PTP_SIMPLE_CALLBACK
-- pv : void* optional, in/out
-- pcbe : TP_CALLBACK_ENVIRON_V3* optional
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const TrySubmitThreadpoolCallback = lib.func('__stdcall', 'TrySubmitThreadpoolCallback', 'int32_t', ['void *', 'void *', 'void *']);
// TrySubmitThreadpoolCallback(pfns, pv, pcbe)
// pfns : PTP_SIMPLE_CALLBACK -> 'void *'
// pv : void* optional, in/out -> 'void *'
// pcbe : TP_CALLBACK_ENVIRON_V3* optional -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
// コールバック(関数ポインタ)は koffi.proto/koffi.register で型を定義して渡す(素の void* では JS 関数を渡せない)。const lib = Deno.dlopen("KERNEL32.dll", {
TrySubmitThreadpoolCallback: { parameters: ["pointer", "pointer", "pointer"], result: "i32" },
});
// lib.symbols.TrySubmitThreadpoolCallback(pfns, pv, pcbe)
// pfns : PTP_SIMPLE_CALLBACK -> "pointer"
// pv : void* optional, in/out -> "pointer"
// pcbe : TP_CALLBACK_ENVIRON_V3* optional -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
int32_t TrySubmitThreadpoolCallback(
void* pfns,
void* pv,
void* pcbe);
C, "KERNEL32.dll");
// $ffi->TrySubmitThreadpoolCallback(pfns, pv, pcbe);
// pfns : PTP_SIMPLE_CALLBACK
// pv : void* optional, in/out
// pcbe : TP_CALLBACK_ENVIRON_V3* optional
// 構造体/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 Kernel32 extends StdCallLibrary {
Kernel32 INSTANCE = Native.load("kernel32", Kernel32.class);
boolean TrySubmitThreadpoolCallback(
Callback pfns, // PTP_SIMPLE_CALLBACK
Pointer pv, // void* optional, in/out
Pointer pcbe // TP_CALLBACK_ENVIRON_V3* optional
);
}@[Link("kernel32")]
lib LibKERNEL32
fun TrySubmitThreadpoolCallback = TrySubmitThreadpoolCallback(
pfns : Void*, # PTP_SIMPLE_CALLBACK
pv : Void*, # void* optional, in/out
pcbe : TP_CALLBACK_ENVIRON_V3* # TP_CALLBACK_ENVIRON_V3* optional
) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。import 'dart:ffi';
import 'package:ffi/ffi.dart';
typedef TrySubmitThreadpoolCallbackNative = Int32 Function(Pointer<Void>, Pointer<Void>, Pointer<Void>);
typedef TrySubmitThreadpoolCallbackDart = int Function(Pointer<Void>, Pointer<Void>, Pointer<Void>);
final TrySubmitThreadpoolCallback = DynamicLibrary.open('KERNEL32.dll')
.lookupFunction<TrySubmitThreadpoolCallbackNative, TrySubmitThreadpoolCallbackDart>('TrySubmitThreadpoolCallback');
// pfns : PTP_SIMPLE_CALLBACK -> Pointer<Void>
// pv : void* optional, in/out -> Pointer<Void>
// pcbe : TP_CALLBACK_ENVIRON_V3* optional -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function TrySubmitThreadpoolCallback(
pfns: Pointer; // PTP_SIMPLE_CALLBACK
pv: Pointer; // void* optional, in/out
pcbe: Pointer // TP_CALLBACK_ENVIRON_V3* optional
): BOOL; stdcall;
external 'KERNEL32.dll' name 'TrySubmitThreadpoolCallback';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "TrySubmitThreadpoolCallback"
c_TrySubmitThreadpoolCallback :: Ptr () -> Ptr () -> Ptr () -> IO CInt
-- pfns : PTP_SIMPLE_CALLBACK -> Ptr ()
-- pv : void* optional, in/out -> Ptr ()
-- pcbe : TP_CALLBACK_ENVIRON_V3* optional -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let trysubmitthreadpoolcallback =
foreign "TrySubmitThreadpoolCallback"
((ptr void) @-> (ptr void) @-> (ptr void) @-> returning int32_t)
(* pfns : PTP_SIMPLE_CALLBACK -> (ptr void) *)
(* pv : void* optional, in/out -> (ptr void) *)
(* pcbe : TP_CALLBACK_ENVIRON_V3* optional -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)
(cffi:defcfun ("TrySubmitThreadpoolCallback" try-submit-threadpool-callback :convention :stdcall) :int32
(pfns :pointer) ; PTP_SIMPLE_CALLBACK
(pv :pointer) ; void* optional, in/out
(pcbe :pointer)) ; TP_CALLBACK_ENVIRON_V3* optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $TrySubmitThreadpoolCallback = Win32::API::More->new('KERNEL32',
'BOOL TrySubmitThreadpoolCallback(LPVOID pfns, LPVOID pv, LPVOID pcbe)');
# my $ret = $TrySubmitThreadpoolCallback->Call($pfns, $pv, $pcbe);
# pfns : PTP_SIMPLE_CALLBACK -> LPVOID
# pv : void* optional, in/out -> LPVOID
# pcbe : TP_CALLBACK_ENVIRON_V3* optional -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# コールバック(関数ポインタ)は Perl sub を直接渡せません。Win32::API::Callback を使用してください。関連項目
公式の関連項目
- f CallbackMayRunLong — コールバックが長時間実行される可能性をプールに通知する。
- f DisassociateCurrentThreadFromCallback — 現在のスレッドをコールバックオブジェクトから切り離す。
- f FreeLibraryWhenCallbackReturns — コールバック完了時に指定DLLを解放する。
- f LeaveCriticalSectionWhenCallbackReturns — コールバック完了時にクリティカルセクションを離脱する。
- f ReleaseMutexWhenCallbackReturns — コールバック完了時に指定ミューテックスを解放する。
- f ReleaseSemaphoreWhenCallbackReturns — コールバック完了時に指定セマフォを解放する。
- f SetEventWhenCallbackReturns — コールバック完了時に指定イベントをシグナル状態にする。