DrawFocusRect

関数

フォーカスを示す破線矩形を反転描画する。

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

シグネチャ

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

BOOL DrawFocusRect(
    HDC hDC,
    const RECT* lprc
);

パラメーター

名前	型	方向	説明
hDC	HDC	in	デバイスコンテキストへのハンドル。
lprc	RECT*	in	四角形の論理座標を指定する RECT 構造体へのポインター。

戻り値の型: BOOL

公式ドキュメント

DrawFocusRect 関数は、四角形がフォーカスを持っていることを示すために使用されるスタイルで四角形を描画します。

戻り値

関数が成功した場合、戻り値は 0 以外になります。

関数が失敗した場合、戻り値は 0 になります。

解説(Remarks)

DrawFocusRect は MM_TEXT モードでのみ動作します。

DrawFocusRect は XOR 関数であるため、同じ四角形を指定して 2 回目を呼び出すと、画面から四角形が消去されます。

この関数は、スクロールできない四角形を描画します。この関数で描画した四角形を含む領域をスクロールするには、まず DrawFocusRect を呼び出して画面から四角形を消去し、領域をスクロールしてから、再度 DrawFocusRect を呼び出して新しい位置に四角形を描画します。

Windows XP: フォーカスの四角形は 1 ピクセルより太くできるようになり、高解像度・高密度ディスプレイやアクセシビリティのニーズに対してより見やすくなりました。これは SystemParametersInfo の SPI_SETFOCUSBORDERWIDTH および SPI_SETFOCUSBORDERHEIGHT によって処理されます。

例

例については、Using List Boxes の「Creating an Owner-Drawn List Box」を参照してください。

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

各言語での呼び出し定義

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

BOOL DrawFocusRect(
    HDC hDC,
    const RECT* lprc
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("USER32.dll", ExactSpelling = true)]
static extern bool DrawFocusRect(
    IntPtr hDC,   // HDC
    IntPtr lprc   // RECT*
);

<DllImport("USER32.dll", ExactSpelling:=True)>
Public Shared Function DrawFocusRect(
    hDC As IntPtr,   ' HDC
    lprc As IntPtr   ' RECT*
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

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

import ctypes
from ctypes import wintypes

DrawFocusRect = ctypes.windll.user32.DrawFocusRect
DrawFocusRect.restype = wintypes.BOOL
DrawFocusRect.argtypes = [
    wintypes.HANDLE,  # hDC : HDC
    ctypes.c_void_p,  # lprc : RECT*
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('USER32.dll')
DrawFocusRect = Fiddle::Function.new(
  lib['DrawFocusRect'],
  [
    Fiddle::TYPE_VOIDP,  # hDC : HDC
    Fiddle::TYPE_VOIDP,  # lprc : RECT*
  ],
  Fiddle::TYPE_INT)

#[link(name = "user32")]
extern "system" {
    fn DrawFocusRect(
        hDC: *mut core::ffi::c_void,  // HDC
        lprc: *const RECT  // RECT*
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

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

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

出力引数:

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