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

SetWindowPlacement

関数
ウィンドウの表示状態と位置情報を設定する。
DLLUSER32.dll呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

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

BOOL SetWindowPlacement(
    HWND hWnd,
    const WINDOWPLACEMENT* lpwndpl
);

パラメーター

名前方向説明
hWndHWNDinウィンドウへのハンドルです。
lpwndplWINDOWPLACEMENT*in

新しい表示状態とウィンドウ位置を指定する WINDOWPLACEMENT 構造体へのポインターです。

SetWindowPlacement を呼び出す前に、WINDOWPLACEMENT 構造体の length メンバーに sizeof(WINDOWPLACEMENT) を設定してください。length メンバーが正しく設定されていない場合、SetWindowPlacement は失敗します。

戻り値の型: BOOL

公式ドキュメント

指定したウィンドウの表示状態、および復元時・最小化時・最大化時の位置を設定します。

戻り値

型: BOOL

関数が成功すると、戻り値は 0 以外の値になります。

関数が失敗すると、戻り値は 0 になります。拡張エラー情報を取得するには、GetLastError を呼び出してください。

解説(Remarks)

WINDOWPLACEMENT で指定された情報によってウィンドウが完全に画面外に出てしまう場合、システムは画面解像度の変更やマルチモニター構成を考慮して、ウィンドウが表示されるように座標を自動的に調整します。

WINDOWPLACEMENTlength メンバーには sizeof(WINDOWPLACEMENT) を設定する必要があります。このメンバーが正しく設定されていない場合、関数は FALSE を返します。ウィンドウ配置座標の正しい使用方法に関する追加の注意事項については、WINDOWPLACEMENT を参照してください。

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

各言語での呼び出し定義

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

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

SetWindowPlacement = ctypes.windll.user32.SetWindowPlacement
SetWindowPlacement.restype = wintypes.BOOL
SetWindowPlacement.argtypes = [
    wintypes.HANDLE,  # hWnd : HWND
    ctypes.c_void_p,  # lpwndpl : WINDOWPLACEMENT*
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('USER32.dll')
SetWindowPlacement = Fiddle::Function.new(
  lib['SetWindowPlacement'],
  [
    Fiddle::TYPE_VOIDP,  # hWnd : HWND
    Fiddle::TYPE_VOIDP,  # lpwndpl : WINDOWPLACEMENT*
  ],
  Fiddle::TYPE_INT)
#[link(name = "user32")]
extern "system" {
    fn SetWindowPlacement(
        hWnd: *mut core::ffi::c_void,  // HWND
        lpwndpl: *const WINDOWPLACEMENT  // WINDOWPLACEMENT*
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("USER32.dll", SetLastError = true)]
public static extern bool SetWindowPlacement(IntPtr hWnd, IntPtr lpwndpl);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_SetWindowPlacement' -Namespace Win32 -PassThru
# $api::SetWindowPlacement(hWnd, lpwndpl)
#uselib "USER32.dll"
#func global SetWindowPlacement "SetWindowPlacement" sptr, sptr
; SetWindowPlacement hWnd, varptr(lpwndpl)   ; 戻り値は stat
; hWnd : HWND -> "sptr"
; lpwndpl : WINDOWPLACEMENT* -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "USER32.dll"
#cfunc global SetWindowPlacement "SetWindowPlacement" sptr, var
; res = SetWindowPlacement(hWnd, lpwndpl)
; hWnd : HWND -> "sptr"
; lpwndpl : WINDOWPLACEMENT* -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; BOOL SetWindowPlacement(HWND hWnd, WINDOWPLACEMENT* lpwndpl)
#uselib "USER32.dll"
#cfunc global SetWindowPlacement "SetWindowPlacement" intptr, var
; res = SetWindowPlacement(hWnd, lpwndpl)
; hWnd : HWND -> "intptr"
; lpwndpl : WINDOWPLACEMENT* -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	user32 = windows.NewLazySystemDLL("USER32.dll")
	procSetWindowPlacement = user32.NewProc("SetWindowPlacement")
)

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

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

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

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

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

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

関連項目

公式の関連項目
使用する型