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

CreateThreadpoolCleanupGroup

関数
スレッドプールのクリーンアップグループを作成する。
DLLKERNEL32.dll呼出規約winapiSetLastErrorあり対応OSWindows Vista 以降

シグネチャ

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

PTP_CLEANUP_GROUP CreateThreadpoolCleanupGroup(void);

パラメーターなし。戻り値: PTP_CLEANUP_GROUP

公式ドキュメント

アプリケーションが 1 つ以上のスレッドプールコールバックを追跡するために使用できるクリーンアップグループを作成します。

戻り値

関数が成功すると、新しく割り当てられたクリーンアップグループの TP_CLEANUP_GROUP 構造体へのポインターを返します。アプリケーションはこの構造体のメンバーを変更しません。

関数が失敗すると、NULL を返します。拡張エラー情報を取得するには、GetLastError を呼び出します。

解説(Remarks)

クリーンアップグループを作成した後、SetThreadpoolCallbackCleanupGroup を呼び出して、クリーンアップグループをコールバック環境に関連付けます。

次のいずれかの関数を呼び出すたびに、メンバーがグループに追加されます。

グループからメンバーを削除するには、次の対応するクローズ関数のいずれかを使用します。

すべてのコールバックをクローズするには、CloseThreadpoolCleanupGroupMembers を呼び出します。

この関数を使用するアプリケーションをコンパイルするには、_WIN32_WINNT を 0x0600 以上として定義します。

例については、スレッドプール関数の使用を参照してください。

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

各言語での呼び出し定義

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

PTP_CLEANUP_GROUP CreateThreadpoolCleanupGroup(void);
[DllImport("KERNEL32.dll", SetLastError = true, ExactSpelling = true)]
static extern IntPtr CreateThreadpoolCleanupGroup();
<DllImport("KERNEL32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function CreateThreadpoolCleanupGroup() As IntPtr
End Function
Declare PtrSafe Function CreateThreadpoolCleanupGroup Lib "kernel32" () As LongPtr
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

CreateThreadpoolCleanupGroup = ctypes.windll.kernel32.CreateThreadpoolCleanupGroup
CreateThreadpoolCleanupGroup.restype = ctypes.c_ssize_t
CreateThreadpoolCleanupGroup.argtypes = []
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
CreateThreadpoolCleanupGroup = Fiddle::Function.new(
  lib['CreateThreadpoolCleanupGroup'],
  [],
  Fiddle::TYPE_INTPTR_T)
#[link(name = "kernel32")]
extern "system" {
    fn CreateThreadpoolCleanupGroup() -> isize;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("KERNEL32.dll", SetLastError = true)]
public static extern IntPtr CreateThreadpoolCleanupGroup();
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_CreateThreadpoolCleanupGroup' -Namespace Win32 -PassThru
# $api::CreateThreadpoolCleanupGroup()
#uselib "KERNEL32.dll"
#func global CreateThreadpoolCleanupGroup "CreateThreadpoolCleanupGroup"
; CreateThreadpoolCleanupGroup   ; 戻り値は stat
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "KERNEL32.dll"
#cfunc global CreateThreadpoolCleanupGroup "CreateThreadpoolCleanupGroup"
; res = CreateThreadpoolCleanupGroup()
; PTP_CLEANUP_GROUP CreateThreadpoolCleanupGroup()
#uselib "KERNEL32.dll"
#cfunc global CreateThreadpoolCleanupGroup "CreateThreadpoolCleanupGroup"
; res = CreateThreadpoolCleanupGroup()
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procCreateThreadpoolCleanupGroup = kernel32.NewProc("CreateThreadpoolCleanupGroup")
)

r1, _, err := procCreateThreadpoolCleanupGroup.Call()
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // PTP_CLEANUP_GROUP
function CreateThreadpoolCleanupGroup: NativeInt; stdcall;
  external 'KERNEL32.dll' name 'CreateThreadpoolCleanupGroup';
result := DllCall("KERNEL32\CreateThreadpoolCleanupGroup", "Ptr")
●CreateThreadpoolCleanupGroup() = DLL("KERNEL32.dll", "int CreateThreadpoolCleanupGroup()")
# 呼び出し: CreateThreadpoolCleanupGroup()
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

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

typedef CreateThreadpoolCleanupGroupNative = IntPtr Function();
typedef CreateThreadpoolCleanupGroupDart = int Function();
final CreateThreadpoolCleanupGroup = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<CreateThreadpoolCleanupGroupNative, CreateThreadpoolCleanupGroupDart>('CreateThreadpoolCleanupGroup');
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function CreateThreadpoolCleanupGroup: NativeInt; stdcall;
  external 'KERNEL32.dll' name 'CreateThreadpoolCleanupGroup';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "CreateThreadpoolCleanupGroup"
  c_CreateThreadpoolCleanupGroup :: IO CIntPtr
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let createthreadpoolcleanupgroup =
  foreign "CreateThreadpoolCleanupGroup"
    (void @-> returning intptr_t)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)

(cffi:defcfun ("CreateThreadpoolCleanupGroup" create-threadpool-cleanup-group :convention :stdcall) :int64)
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $CreateThreadpoolCleanupGroup = Win32::API::More->new('KERNEL32',
    'LPARAM CreateThreadpoolCleanupGroup()');
# my $ret = $CreateThreadpoolCleanupGroup->Call();
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目