DrawFrameControl

関数

ボタンやスクロールバーなどのフレームコントロールを描画する。

DLLUSER32.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

BOOL DrawFrameControl(
    HDC hdc,
    RECT* lprc,
    DWORD uType,
    DWORD uState
);

パラメーター

名前

型

方向

説明

hdc

HDC

コントロールを描画するウィンドウのデバイスコンテキストへのハンドル。

lprc

RECT*

inout

フレームコントロールの外接矩形の論理座標を格納する RECT 構造体へのポインター。

uType

DWORD

描画するフレームコントロールの種類。このパラメーターには次のいずれかの値を指定できます。

値	意味
DFC_BUTTON	標準ボタン
DFC_CAPTION	タイトルバー
DFC_MENU	メニューバー
DFC_POPUPMENU	ポップアップメニュー項目。
DFC_SCROLL	スクロールバー

uState

DWORD

フレームコントロールの初期状態。uType が DFC_BUTTON の場合、uState には次のいずれかの値を指定できます。

値	意味
DFCS_BUTTON3STATE	3 状態ボタン
DFCS_BUTTONCHECK	チェックボックス
DFCS_BUTTONPUSH	プッシュボタン
DFCS_BUTTONRADIO	ラジオボタン
DFCS_BUTTONRADIOIMAGE	ラジオボタン用のイメージ (正方形でない場合はイメージが必要)
DFCS_BUTTONRADIOMASK	ラジオボタン用のマスク (正方形でない場合はマスクが必要)

uType が DFC_CAPTION の場合、uState には次のいずれかの値を指定できます。

値	意味
DFCS_CAPTIONCLOSE	閉じるボタン
DFCS_CAPTIONHELP	ヘルプボタン
DFCS_CAPTIONMAX	最大化ボタン
DFCS_CAPTIONMIN	最小化ボタン
DFCS_CAPTIONRESTORE	元に戻すボタン

uType が DFC_MENU の場合、uState には次のいずれかの値を指定できます。

値	意味
DFCS_MENUARROW	サブメニューの矢印
DFCS_MENUARROWRIGHT	左を指すサブメニューの矢印。アラビア語やヘブライ語などの右から左へ記述する言語で使用される、右から左へのカスケードメニューに使用されます。
DFCS_MENUBULLET	行頭文字 (ブレット)
DFCS_MENUCHECK	チェックマーク

uType が DFC_SCROLL の場合、uState には次のいずれかの値を指定できます。

値	意味
DFCS_SCROLLCOMBOBOX	コンボボックスのスクロールバー
DFCS_SCROLLDOWN	スクロールバーの下矢印
DFCS_SCROLLLEFT	スクロールバーの左矢印
DFCS_SCROLLRIGHT	スクロールバーの右矢印
DFCS_SCROLLSIZEGRIP	ウィンドウ右下隅のサイズグリップ
DFCS_SCROLLSIZEGRIPRIGHT	ウィンドウ左下隅のサイズグリップ。アラビア語やヘブライ語などの右から左へ記述する言語で使用されます。
DFCS_SCROLLUP	スクロールバーの上矢印

プッシュボタンの外接矩形を調整するには、次のスタイルを使用できます。

値	意味
DFCS_ADJUSTRECT	外接矩形は、プッシュボタンを囲むエッジを除外するように調整されます。

描画するコントロールの状態を設定するには、次の値を 1 つ以上使用できます。

値	意味
DFCS_CHECKED	ボタンがチェックされています。
DFCS_FLAT	ボタンにフラットな境界線があります。
DFCS_HOT	ボタンがホットトラッキングされています。
DFCS_INACTIVE	ボタンが非アクティブ (グレー表示) です。
DFCS_MONO	ボタンにモノクロの境界線があります。
DFCS_PUSHED	ボタンが押されています。
DFCS_TRANSPARENT	背景は変更されないまま残されます。このフラグは DFCS_MENUARROWUP または DFCS_MENUARROWDOWN とのみ組み合わせることができます。

戻り値の型: BOOL

公式ドキュメント

DrawFrameControl 関数は、指定された種類とスタイルのフレームコントロールを描画します。

戻り値

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

関数が失敗すると、戻り値は 0 になります。

解説(Remarks)

uType が DFC_MENU または DFC_BUTTON のいずれかであり、uState が DFCS_BUTTONPUSH でない場合、フレームコントロールは白地に黒のマスク (つまり、白い背景に黒のフレームコントロール) になります。このような場合、アプリケーションはビットマップメモリデバイスコントロールへのハンドルを渡す必要があります。アプリケーションは、関連付けられたビットマップを MaskBlt 関数の hbmMask パラメーターとして使用するか、あるいは SRCAND や SRCINVERT などの ROP を使用してそのデバイスコンテキストを BitBlt 関数のパラメーターとして使用できます。

DPI 仮想化

この API は DPI 仮想化に参加しません。入力は常に物理ピクセル単位で与えられ、呼び出し元のコンテキストとは関係ありません。

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

各言語での呼び出し定義

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

BOOL DrawFrameControl(
    HDC hdc,
    RECT* lprc,
    DWORD uType,
    DWORD uState
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("USER32.dll", ExactSpelling = true)]
static extern bool DrawFrameControl(
    IntPtr hdc,   // HDC
    IntPtr lprc,   // RECT* in/out
    uint uType,   // DWORD
    uint uState   // DWORD
);

<DllImport("USER32.dll", ExactSpelling:=True)>
Public Shared Function DrawFrameControl(
    hdc As IntPtr,   ' HDC
    lprc As IntPtr,   ' RECT* in/out
    uType As UInteger,   ' DWORD
    uState As UInteger   ' DWORD
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' hdc : HDC
' lprc : RECT* in/out
' uType : DWORD
' uState : DWORD
Declare PtrSafe Function DrawFrameControl Lib "user32" ( _
    ByVal hdc As LongPtr, _
    ByVal lprc As LongPtr, _
    ByVal uType As Long, _
    ByVal uState As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

DrawFrameControl = ctypes.windll.user32.DrawFrameControl
DrawFrameControl.restype = wintypes.BOOL
DrawFrameControl.argtypes = [
    wintypes.HANDLE,  # hdc : HDC
    ctypes.c_void_p,  # lprc : RECT* in/out
    wintypes.DWORD,  # uType : DWORD
    wintypes.DWORD,  # uState : DWORD
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('USER32.dll')
DrawFrameControl = Fiddle::Function.new(
  lib['DrawFrameControl'],
  [
    Fiddle::TYPE_VOIDP,  # hdc : HDC
    Fiddle::TYPE_VOIDP,  # lprc : RECT* in/out
    -Fiddle::TYPE_INT,  # uType : DWORD
    -Fiddle::TYPE_INT,  # uState : DWORD
  ],
  Fiddle::TYPE_INT)

#[link(name = "user32")]
extern "system" {
    fn DrawFrameControl(
        hdc: *mut core::ffi::c_void,  // HDC
        lprc: *mut RECT,  // RECT* in/out
        uType: u32,  // DWORD
        uState: u32  // DWORD
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("USER32.dll")]
public static extern bool DrawFrameControl(IntPtr hdc, IntPtr lprc, uint uType, uint uState);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_DrawFrameControl' -Namespace Win32 -PassThru
# $api::DrawFrameControl(hdc, lprc, uType, uState)

#uselib "USER32.dll"
#func global DrawFrameControl "DrawFrameControl" sptr, sptr, sptr, sptr
; DrawFrameControl hdc, varptr(lprc), uType, uState   ; 戻り値は stat
; hdc : HDC -> "sptr"
; lprc : RECT* in/out -> "sptr"
; uType : DWORD -> "sptr"
; uState : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "USER32.dll"
#cfunc global DrawFrameControl "DrawFrameControl" sptr, var, int, int
; res = DrawFrameControl(hdc, lprc, uType, uState)
; hdc : HDC -> "sptr"
; lprc : RECT* in/out -> "var"
; uType : DWORD -> "int"
; uState : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "USER32.dll"
#cfunc global DrawFrameControl "DrawFrameControl" sptr, sptr, int, int
; res = DrawFrameControl(hdc, varptr(lprc), uType, uState)
; hdc : HDC -> "sptr"
; lprc : RECT* in/out -> "sptr"
; uType : DWORD -> "int"
; uState : DWORD -> "int"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。