Win32 API 日本語リファレンス
ホームUI.WindowsAndMessaging › BeginDeferWindowPos

BeginDeferWindowPos

関数
複数ウィンドウ位置の一括更新処理を開始する。
DLLUSER32.dll呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

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

HDWP BeginDeferWindowPos(
    INT nNumWindows
);

パラメーター

名前方向説明
nNumWindowsINTin位置情報を格納するウィンドウの初期数です。必要に応じて DeferWindowPos 関数が構造体のサイズを拡張します。

戻り値の型: HDWP

公式ドキュメント

複数ウィンドウの位置情報構造体のためのメモリを割り当て、その構造体へのハンドルを返します。

戻り値

型: HDWP

関数が成功した場合、戻り値は複数ウィンドウの位置情報構造体を識別します。構造体を割り当てるのに十分なシステムリソースが利用できない場合、戻り値は NULL になります。拡張エラー情報を取得するには、GetLastError を呼び出します。

解説(Remarks)

複数ウィンドウの位置情報構造体は内部構造体であり、アプリケーションが直接アクセスすることはできません。

DeferWindowPos は、これから移動される 1 つ以上のウィンドウの目標位置に関する情報を、複数ウィンドウの位置情報構造体に書き込みます。EndDeferWindowPos 関数はこの構造体へのハンドルを受け取り、構造体に格納された情報を使用してウィンドウを再配置します。

nNumWindows パラメーターで指定された初期サイズを超えて複数ウィンドウの位置情報構造体のサイズを拡張する必要があるにもかかわらず、そのために十分なメモリを割り当てられない場合、システムはウィンドウ位置設定シーケンス全体(BeginDeferWindowPosDeferWindowPosEndDeferWindowPos)を失敗させます。必要な最大サイズを指定しておくことで、アプリケーションは処理の早い段階で失敗を検出し処理できます。

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

各言語での呼び出し定義

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

HDWP BeginDeferWindowPos(
    INT nNumWindows
);
[DllImport("USER32.dll", SetLastError = true, ExactSpelling = true)]
static extern IntPtr BeginDeferWindowPos(
    int nNumWindows   // INT
);
<DllImport("USER32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function BeginDeferWindowPos(
    nNumWindows As Integer   ' INT
) As IntPtr
End Function
' nNumWindows : INT
Declare PtrSafe Function BeginDeferWindowPos Lib "user32" ( _
    ByVal nNumWindows As Long) As LongPtr
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

BeginDeferWindowPos = ctypes.windll.user32.BeginDeferWindowPos
BeginDeferWindowPos.restype = ctypes.c_void_p
BeginDeferWindowPos.argtypes = [
    ctypes.c_int,  # nNumWindows : INT
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('USER32.dll')
BeginDeferWindowPos = Fiddle::Function.new(
  lib['BeginDeferWindowPos'],
  [
    Fiddle::TYPE_INT,  # nNumWindows : INT
  ],
  Fiddle::TYPE_VOIDP)
#[link(name = "user32")]
extern "system" {
    fn BeginDeferWindowPos(
        nNumWindows: i32  // INT
    ) -> *mut core::ffi::c_void;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("USER32.dll", SetLastError = true)]
public static extern IntPtr BeginDeferWindowPos(int nNumWindows);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_BeginDeferWindowPos' -Namespace Win32 -PassThru
# $api::BeginDeferWindowPos(nNumWindows)
#uselib "USER32.dll"
#func global BeginDeferWindowPos "BeginDeferWindowPos" sptr
; BeginDeferWindowPos nNumWindows   ; 戻り値は stat
; nNumWindows : INT -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "USER32.dll"
#cfunc global BeginDeferWindowPos "BeginDeferWindowPos" int
; res = BeginDeferWindowPos(nNumWindows)
; nNumWindows : INT -> "int"
; HDWP BeginDeferWindowPos(INT nNumWindows)
#uselib "USER32.dll"
#cfunc global BeginDeferWindowPos "BeginDeferWindowPos" int
; res = BeginDeferWindowPos(nNumWindows)
; nNumWindows : INT -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	user32 = windows.NewLazySystemDLL("USER32.dll")
	procBeginDeferWindowPos = user32.NewProc("BeginDeferWindowPos")
)

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

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

typedef BeginDeferWindowPosNative = Pointer<Void> Function(Int32);
typedef BeginDeferWindowPosDart = Pointer<Void> Function(int);
final BeginDeferWindowPos = DynamicLibrary.open('USER32.dll')
    .lookupFunction<BeginDeferWindowPosNative, BeginDeferWindowPosDart>('BeginDeferWindowPos');
// nNumWindows : INT -> Int32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function BeginDeferWindowPos(
  nNumWindows: Integer   // INT
): THandle; stdcall;
  external 'USER32.dll' name 'BeginDeferWindowPos';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "BeginDeferWindowPos"
  c_BeginDeferWindowPos :: Int32 -> IO (Ptr ())
-- nNumWindows : INT -> Int32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let begindeferwindowpos =
  foreign "BeginDeferWindowPos"
    (int32_t @-> returning (ptr void))
(* nNumWindows : INT -> int32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library user32 (t "USER32.dll"))
(cffi:use-foreign-library user32)

(cffi:defcfun ("BeginDeferWindowPos" begin-defer-window-pos :convention :stdcall) :pointer
  (n-num-windows :int32))   ; INT
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $BeginDeferWindowPos = Win32::API::More->new('USER32',
    'HANDLE BeginDeferWindowPos(int nNumWindows)');
# my $ret = $BeginDeferWindowPos->Call($nNumWindows);
# nNumWindows : INT -> int
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目