ホーム › Graphics.Gdi › GdiSetBatchLimit
GdiSetBatchLimit
関数GDI描画呼び出しのバッチ処理上限を設定する。
シグネチャ
// GDI32.dll
#include <windows.h>
DWORD GdiSetBatchLimit(
DWORD dw
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| dw | DWORD | in | 設定するバッチ制限値を指定します。値 0 は既定の制限を設定します。値 1 はバッチ処理を無効にします。 |
戻り値の型: DWORD
公式ドキュメント
GdiSetBatchLimit 関数は、呼び出し元スレッドの現在のバッチに蓄積できる関数呼び出しの最大数を設定します。この制限を超えると、システムは現在のバッチをフラッシュします。
戻り値
関数が成功した場合、戻り値は以前のバッチ制限値です。
関数が失敗した場合、戻り値は 0 です。
解説(Remarks)
現在のバッチに蓄積できるのは、Boolean 値を返す GDI 描画関数のみです。その他の GDI 関数を呼び出すと、現在のバッチは直ちにフラッシュされます。バッチ制限を超えた場合や GdiFlush 関数を呼び出した場合も、現在のバッチがフラッシュされます。
システムが関数呼び出しを蓄積するとき、関数はバッチ内にあることを示すために TRUE を返します。システムが現在のバッチをフラッシュし、関数を 2 回目に実行すると、戻り値は関数が成功したかどうかに応じて TRUE または FALSE のいずれかになります。この 2 回目の戻り値は、GdiFlush を使用してバッチをフラッシュした場合にのみ報告されます。
注意 バッチ制限はスレッドごとに個別に管理されます。バッチ処理を完全に無効にするには、各スレッドの初期化時に GdiSetBatchLimit (1) を呼び出してください。
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// GDI32.dll
#include <windows.h>
DWORD GdiSetBatchLimit(
DWORD dw
);[DllImport("GDI32.dll", ExactSpelling = true)]
static extern uint GdiSetBatchLimit(
uint dw // DWORD
);<DllImport("GDI32.dll", ExactSpelling:=True)>
Public Shared Function GdiSetBatchLimit(
dw As UInteger ' DWORD
) As UInteger
End Function' dw : DWORD
Declare PtrSafe Function GdiSetBatchLimit Lib "gdi32" ( _
ByVal dw As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。import ctypes
from ctypes import wintypes
GdiSetBatchLimit = ctypes.windll.gdi32.GdiSetBatchLimit
GdiSetBatchLimit.restype = wintypes.DWORD
GdiSetBatchLimit.argtypes = [
wintypes.DWORD, # dw : DWORD
]require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('GDI32.dll')
GdiSetBatchLimit = Fiddle::Function.new(
lib['GdiSetBatchLimit'],
[
-Fiddle::TYPE_INT, # dw : DWORD
],
-Fiddle::TYPE_INT)#[link(name = "gdi32")]
extern "system" {
fn GdiSetBatchLimit(
dw: u32 // DWORD
) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.$sig = @"
[DllImport("GDI32.dll")]
public static extern uint GdiSetBatchLimit(uint dw);
"@
$api = Add-Type -MemberDefinition $sig -Name 'GDI32_GdiSetBatchLimit' -Namespace Win32 -PassThru
# $api::GdiSetBatchLimit(dw)#uselib "GDI32.dll"
#func global GdiSetBatchLimit "GdiSetBatchLimit" sptr
; GdiSetBatchLimit dw ; 戻り値は stat
; dw : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "GDI32.dll"
#cfunc global GdiSetBatchLimit "GdiSetBatchLimit" int
; res = GdiSetBatchLimit(dw)
; dw : DWORD -> "int"; DWORD GdiSetBatchLimit(DWORD dw)
#uselib "GDI32.dll"
#cfunc global GdiSetBatchLimit "GdiSetBatchLimit" int
; res = GdiSetBatchLimit(dw)
; dw : DWORD -> "int"import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
gdi32 = windows.NewLazySystemDLL("GDI32.dll")
procGdiSetBatchLimit = gdi32.NewProc("GdiSetBatchLimit")
)
// dw (DWORD)
r1, _, err := procGdiSetBatchLimit.Call(
uintptr(dw),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // DWORDfunction GdiSetBatchLimit(
dw: DWORD // DWORD
): DWORD; stdcall;
external 'GDI32.dll' name 'GdiSetBatchLimit';result := DllCall("GDI32\GdiSetBatchLimit"
, "UInt", dw ; DWORD
, "UInt") ; return: DWORD●GdiSetBatchLimit(dw) = DLL("GDI32.dll", "dword GdiSetBatchLimit(dword)")
# 呼び出し: GdiSetBatchLimit(dw)
# dw : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "gdi32" fn GdiSetBatchLimit(
dw: u32 // DWORD
) callconv(std.os.windows.WINAPI) u32;proc GdiSetBatchLimit(
dw: uint32 # DWORD
): uint32 {.importc: "GdiSetBatchLimit", stdcall, dynlib: "GDI32.dll".}pragma(lib, "gdi32");
extern(Windows)
uint GdiSetBatchLimit(
uint dw // DWORD
);ccall((:GdiSetBatchLimit, "GDI32.dll"), stdcall, UInt32,
(UInt32,),
dw)
# dw : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
uint32_t GdiSetBatchLimit(
uint32_t dw);
]]
local gdi32 = ffi.load("gdi32")
-- gdi32.GdiSetBatchLimit(dw)
-- dw : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('GDI32.dll');
const GdiSetBatchLimit = lib.func('__stdcall', 'GdiSetBatchLimit', 'uint32_t', ['uint32_t']);
// GdiSetBatchLimit(dw)
// dw : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("GDI32.dll", {
GdiSetBatchLimit: { parameters: ["u32"], result: "u32" },
});
// lib.symbols.GdiSetBatchLimit(dw)
// dw : DWORD -> "u32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
uint32_t GdiSetBatchLimit(
uint32_t dw);
C, "GDI32.dll");
// $ffi->GdiSetBatchLimit(dw);
// dw : DWORD
// 構造体/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 GdiSetBatchLimit(
int dw // DWORD
);
}@[Link("gdi32")]
lib LibGDI32
fun GdiSetBatchLimit = GdiSetBatchLimit(
dw : UInt32 # DWORD
) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。import 'dart:ffi';
import 'package:ffi/ffi.dart';
typedef GdiSetBatchLimitNative = Uint32 Function(Uint32);
typedef GdiSetBatchLimitDart = int Function(int);
final GdiSetBatchLimit = DynamicLibrary.open('GDI32.dll')
.lookupFunction<GdiSetBatchLimitNative, GdiSetBatchLimitDart>('GdiSetBatchLimit');
// dw : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function GdiSetBatchLimit(
dw: DWORD // DWORD
): DWORD; stdcall;
external 'GDI32.dll' name 'GdiSetBatchLimit';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "GdiSetBatchLimit"
c_GdiSetBatchLimit :: Word32 -> IO Word32
-- dw : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let gdisetbatchlimit =
foreign "GdiSetBatchLimit"
(uint32_t @-> returning uint32_t)
(* dw : DWORD -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)(cffi:define-foreign-library gdi32 (t "GDI32.dll"))
(cffi:use-foreign-library gdi32)
(cffi:defcfun ("GdiSetBatchLimit" gdi-set-batch-limit :convention :stdcall) :uint32
(dw :uint32)) ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $GdiSetBatchLimit = Win32::API::More->new('GDI32',
'DWORD GdiSetBatchLimit(DWORD dw)');
# my $ret = $GdiSetBatchLimit->Call($dw);
# dw : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。関連項目
公式の関連項目
- f GdiFlush — 現在のスレッドのGDI描画バッチを処理して完了させる。
- f GdiGetBatchLimit — 現在のGDI描画バッチ処理上限を取得する。