Win32 API 日本語リファレンス
ホームGraphics.Gdi › GdiGetBatchLimit

GdiGetBatchLimit

関数
現在のGDI描画バッチ処理上限を取得する。
DLLGDI32.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

DWORD GdiGetBatchLimit(void);

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

公式ドキュメント

GdiGetBatchLimit 関数は、呼び出し元スレッドの現在のバッチに蓄積できる関数呼び出しの最大数を返します。システムは、この制限を超えるたびに現在のバッチをフラッシュします。

戻り値

関数が成功した場合、戻り値はバッチ制限値です。

関数が失敗した場合、戻り値は 0 です。

解説(Remarks)

バッチ制限は GdiSetBatchLimit 関数を使用して設定します。制限を 1 に設定すると、バッチ処理は実質的に無効になります。

バッチ処理できるのは、Boolean 値を返す GDI 描画関数のみです。他の GDI 関数を呼び出すと、現在のバッチは直ちにフラッシュされます。バッチ制限を超えた場合や GdiFlush 関数を呼び出した場合も、現在のバッチがフラッシュされます。

システムが関数呼び出しをバッチ処理すると、その関数は TRUE を返します。関数の実際の戻り値は、GdiFlush を使用してバッチをフラッシュした場合にのみ報告されます。

注意 バッチ制限はスレッドごとに個別に維持されます。バッチ処理を完全に無効にするには、各スレッドの初期化時に GdiSetBatchLimit (1) を呼び出してください。
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

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

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

GdiGetBatchLimit = ctypes.windll.gdi32.GdiGetBatchLimit
GdiGetBatchLimit.restype = wintypes.DWORD
GdiGetBatchLimit.argtypes = []
require 'fiddle'
require 'fiddle/import'

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

var (
	gdi32 = windows.NewLazySystemDLL("GDI32.dll")
	procGdiGetBatchLimit = gdi32.NewProc("GdiGetBatchLimit")
)

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

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

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

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

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

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

関連項目

公式の関連項目