ホーム › UI.Controls › GetEffectiveClientRect

GetEffectiveClientRect

関数

指定コントロールを除いた有効クライアント領域を計算する。

DLLCOMCTL32.dll呼出規約winapi対応OSWindows Vista 以降

シグネチャ

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

void GetEffectiveClientRect(
    HWND hWnd,
    RECT* lprc,
    const INT* lpInfo
);

パラメーター

名前	型	方向	説明
hWnd	HWND	in	対象となるクライアント領域を持つウィンドウへのハンドル。
lprc	RECT*	out	矩形の寸法を受け取る RECT 構造体へのポインター。
lpInfo	INT*	in	クライアント領域内のコントロールを識別する、null 終端の整数配列へのポインター。各コントロールには連続する 2 つの要素のペアが必要です。ペアの最初の要素は 0 以外でなければならず、2 番目の要素はコントロール識別子でなければなりません。最初のペアはメニューを表し、無視されます。配列の終端を示すため、最後の要素は 0 でなければなりません。

戻り値の型: void

公式ドキュメント

指定したすべてのコントロールを含む、クライアント領域内の矩形の寸法を計算します。

解説(Remarks)

lprc 配列内のウィンドウが表示されている場合、または親ウィンドウが表示されたときに表示される場合、そのウィンドウの矩形は実効クライアント矩形から差し引かれます。

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

各言語での呼び出し定義

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

void GetEffectiveClientRect(
    HWND hWnd,
    RECT* lprc,
    const INT* lpInfo
);

[DllImport("COMCTL32.dll", ExactSpelling = true)]
static extern void GetEffectiveClientRect(
    IntPtr hWnd,   // HWND
    IntPtr lprc,   // RECT* out
    ref int lpInfo   // INT*
);

<DllImport("COMCTL32.dll", ExactSpelling:=True)>
Public Shared Sub GetEffectiveClientRect(
    hWnd As IntPtr,   ' HWND
    lprc As IntPtr,   ' RECT* out
    ByRef lpInfo As Integer   ' INT*
)
End Sub

' hWnd : HWND
' lprc : RECT* out
' lpInfo : INT*
Declare PtrSafe Sub GetEffectiveClientRect Lib "comctl32" ( _
    ByVal hWnd As LongPtr, _
    ByVal lprc As LongPtr, _
    ByRef lpInfo As Long)
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

GetEffectiveClientRect = ctypes.windll.comctl32.GetEffectiveClientRect
GetEffectiveClientRect.restype = None
GetEffectiveClientRect.argtypes = [
    wintypes.HANDLE,  # hWnd : HWND
    ctypes.c_void_p,  # lprc : RECT* out
    ctypes.POINTER(ctypes.c_int),  # lpInfo : INT*
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('COMCTL32.dll')
GetEffectiveClientRect = Fiddle::Function.new(
  lib['GetEffectiveClientRect'],
  [
    Fiddle::TYPE_VOIDP,  # hWnd : HWND
    Fiddle::TYPE_VOIDP,  # lprc : RECT* out
    Fiddle::TYPE_VOIDP,  # lpInfo : INT*
  ],
  Fiddle::TYPE_VOID)

#[link(name = "comctl32")]
extern "system" {
    fn GetEffectiveClientRect(
        hWnd: *mut core::ffi::c_void,  // HWND
        lprc: *mut RECT,  // RECT* out
        lpInfo: *const i32  // INT*
    );
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("COMCTL32.dll")]
public static extern void GetEffectiveClientRect(IntPtr hWnd, IntPtr lprc, ref int lpInfo);
"@
$api = Add-Type -MemberDefinition $sig -Name 'COMCTL32_GetEffectiveClientRect' -Namespace Win32 -PassThru
# $api::GetEffectiveClientRect(hWnd, lprc, lpInfo)

#uselib "COMCTL32.dll"
#func global GetEffectiveClientRect "GetEffectiveClientRect" sptr, sptr, sptr
; GetEffectiveClientRect hWnd, varptr(lprc), varptr(lpInfo)
; hWnd : HWND -> "sptr"
; lprc : RECT* out -> "sptr"
; lpInfo : INT* -> "sptr"

出力引数:

#uselib "COMCTL32.dll"
#func global GetEffectiveClientRect "GetEffectiveClientRect" sptr, var, var
; GetEffectiveClientRect hWnd, lprc, lpInfo
; hWnd : HWND -> "sptr"
; lprc : RECT* out -> "var"
; lpInfo : INT* -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "COMCTL32.dll"
#func global GetEffectiveClientRect "GetEffectiveClientRect" sptr, sptr, sptr
; GetEffectiveClientRect hWnd, varptr(lprc), varptr(lpInfo)
; hWnd : HWND -> "sptr"
; lprc : RECT* out -> "sptr"
; lpInfo : INT* -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。