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

LockWindowUpdate

関数
指定ウィンドウの描画を一時的に禁止またはロック解除する。
DLLUSER32.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

BOOL LockWindowUpdate(
    HWND hWndLock   // optional
);

パラメーター

名前方向説明
hWndLockHWNDinoptional描画を無効化するウィンドウです。このパラメーターが NULL の場合、ロックされていたウィンドウでの描画が有効化されます。

戻り値の型: BOOL

公式ドキュメント

LockWindowUpdate 関数は、指定したウィンドウでの描画を無効化または有効化します。一度にロックできるウィンドウは 1 つだけです。

戻り値

関数が成功した場合、戻り値は 0 以外の値です。

関数が失敗した場合、戻り値は 0 であり、エラーが発生したか、別のウィンドウが既にロックされていることを示します。

解説(Remarks)

LockWindowUpdate 関数の目的は、ウィンドウ自体による干渉を受けずに、ドラッグ&ドロップのフィードバックをウィンドウ上に描画できるようにすることです。フィードバックの描画中はウィンドウをロックし、フィードバックが完了したらロックを解除することを想定しています。LockWindowUpdate は、ウィンドウの再描画を汎用的に抑止する用途を意図したものではありません。特定のウィンドウの再描画を無効化するには、WM_SETREDRAW メッセージを使用してください。

ロックされたウィンドウ (またはロックされた子ウィンドウ) を持つアプリケーションが GetDCGetDCEx、または BeginPaint 関数を呼び出すと、呼び出された関数は表示領域が空のデバイス コンテキストを返します。この状態は、アプリケーションが hWndLockNULL を指定して LockWindowUpdate を呼び出し、ウィンドウのロックを解除するまで続きます。

ロックされたウィンドウ内でアプリケーションが描画を試みると、システムはその描画操作の範囲を境界四角形に記録します。ウィンドウのロックが解除されると、システムはこの境界四角形内の領域を無効化し、最終的に WM_PAINT メッセージが、それまでロックされていたウィンドウとその子ウィンドウへ送られるようにします。ウィンドウの更新がロックされている間に描画が行われなかった場合は、いずれの領域も無効化されません。

LockWindowUpdate は、指定したウィンドウを非表示にすることはなく、WS_VISIBLE スタイル ビットをクリアすることもありません。

ロックされたウィンドウは移動できません。

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

各言語での呼び出し定義

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

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

LockWindowUpdate = ctypes.windll.user32.LockWindowUpdate
LockWindowUpdate.restype = wintypes.BOOL
LockWindowUpdate.argtypes = [
    wintypes.HANDLE,  # hWndLock : HWND optional
]
require 'fiddle'
require 'fiddle/import'

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

var (
	user32 = windows.NewLazySystemDLL("USER32.dll")
	procLockWindowUpdate = user32.NewProc("LockWindowUpdate")
)

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

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

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

foreign import stdcall safe "LockWindowUpdate"
  c_LockWindowUpdate :: Ptr () -> IO CInt
-- hWndLock : HWND optional -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

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

(cffi:defcfun ("LockWindowUpdate" lock-window-update :convention :stdcall) :int32
  (h-wnd-lock :pointer))   ; HWND optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $LockWindowUpdate = Win32::API::More->new('USER32',
    'BOOL LockWindowUpdate(HANDLE hWndLock)');
# my $ret = $LockWindowUpdate->Call($hWndLock);
# hWndLock : HWND optional -> HANDLE
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目