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

CallbackMayRunLong

関数
コールバックが長時間実行される可能性をプールに通知する。
DLLKERNEL32.dll呼出規約winapi対応OSWindows Vista 以降

シグネチャ

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

BOOL CallbackMayRunLong(
    PTP_CALLBACK_INSTANCE pci
);

パラメーター

名前方向説明
pciPTP_CALLBACK_INSTANCEinコールバック インスタンスを定義する TP_CALLBACK_INSTANCE 構造体へのポインターです。このポインターはコールバック関数に渡されます。

戻り値の型: BOOL

公式ドキュメント

コールバックがすぐに復帰しない可能性があることを示します。

戻り値

スレッド プール内に他にコールバックを処理できるスレッドが存在する場合、またはスレッド プールが新しいスレッドを作成できた場合、この関数は TRUE を返します。この場合、現在のコールバック関数は現在のスレッドを無期限に使用できます。

スレッド プール内に他にコールバックを処理できるスレッドが存在せず、かつスレッド プールが新しいスレッドを作成できなかった場合、この関数は FALSE を返します。スレッド プールは遅延後に新しいスレッドの作成を試みますが、現在のコールバック関数の実行が長引くと、スレッド プールの効率が低下する可能性があります。

解説(Remarks)

スレッド プールは、この情報を利用して新しいスレッドをいつ作成すべきかをより適切に判断できます。

CallbackMayRunLong 関数は、コールバックを処理しているスレッドからのみ呼び出してください。他のスレッドからこの関数を呼び出すと、競合状態が発生する可能性があります。

CallbackMayRunLong 関数は、コールバックを処理できるスレッドが利用可能かどうか、またスレッド プールが新しいスレッドを割り当てられるかどうかに関わらず、常にコールバックを長時間実行するものとしてマークします。したがって、この関数は FALSE を返した場合でも、1 回だけ呼び出すようにしてください。

この関数を使用するアプリケーションをコンパイルするには、_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>

BOOL CallbackMayRunLong(
    PTP_CALLBACK_INSTANCE pci
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", ExactSpelling = true)]
static extern bool CallbackMayRunLong(
    IntPtr pci   // PTP_CALLBACK_INSTANCE
);
<DllImport("KERNEL32.dll", ExactSpelling:=True)>
Public Shared Function CallbackMayRunLong(
    pci As IntPtr   ' PTP_CALLBACK_INSTANCE
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' pci : PTP_CALLBACK_INSTANCE
Declare PtrSafe Function CallbackMayRunLong Lib "kernel32" ( _
    ByVal pci As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

CallbackMayRunLong = ctypes.windll.kernel32.CallbackMayRunLong
CallbackMayRunLong.restype = wintypes.BOOL
CallbackMayRunLong.argtypes = [
    ctypes.c_ssize_t,  # pci : PTP_CALLBACK_INSTANCE
]
require 'fiddle'
require 'fiddle/import'

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

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procCallbackMayRunLong = kernel32.NewProc("CallbackMayRunLong")
)

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

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

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

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

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

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

関連項目

公式の関連項目