DrawStatusTextW

関数

ステータスバー風の枠付きテキストを描画する(Unicode版)。

DLLCOMCTL32.dll文字セットUnicode (-W)呼出規約winapi対応OSWindows Vista 以降

シグネチャ

// COMCTL32.dll  (Unicode / -W)
#include <windows.h>

void DrawStatusTextW(
    HDC hDC,
    RECT* lprc,
    LPCWSTR pszText,
    DWORD uFlags
);

パラメーター

名前

型

方向

説明

hDC

HDC

ウィンドウの表示コンテキストへのハンドルです。

lprc

RECT*

inout

テキストを描画する矩形の位置をクライアント座標で格納する RECT 構造体へのポインターです。この関数は、指定した矩形の端のすぐ内側に枠を描画します。

pszText

LPCWSTR

表示するテキストを指定する、null 終端文字列へのポインターです。文字列中のタブ文字によって、文字列を左揃え、右揃え、中央揃えのいずれにするかが決まります。

uFlags

DWORD

テキスト描画フラグです。このパラメーターには、次の値を組み合わせて指定できます。

値	意味
SBT_NOBORDERS	指定したテキストの周囲に枠を描画しないようにします。
SBT_POPOUT	テキストが浮き出て見えるように、ハイライトされた枠を描画します。
SBT_RTLREADING	pszText が指す文字列を、親ウィンドウのテキストとは逆方向に表示することを示します。

戻り値の型: void

公式ドキュメント

DrawStatusText 関数は、指定したテキストを枠付きのステータスウィンドウのスタイルで描画します。(Unicode)

解説(Remarks)

通常のウィンドウは、テキストを左から右(LTR)に表示します。ウィンドウはミラー化することで、ヘブライ語やアラビア語のように右から左(RTL)に読む言語を表示できます。通常、pszText 文字列は、その親ウィンドウのテキストと同じ方向に表示されます。SBT_RTLREADING が設定されている場合、pszText 文字列は親ウィンドウのテキストとは逆方向に読まれます。

メモ

commctrl.h ヘッダーは、DrawStatusText を、UNICODE プリプロセッサ定数の定義に基づいてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして定義しています。エンコーディング非依存のエイリアスを、エンコーディング非依存でないコードと混在して使用すると、不一致が生じ、コンパイルエラーや実行時エラーの原因となることがあります。詳細については、Conventions for Function Prototypes を参照してください。

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

各言語での呼び出し定義

// COMCTL32.dll  (Unicode / -W)
#include <windows.h>

void DrawStatusTextW(
    HDC hDC,
    RECT* lprc,
    LPCWSTR pszText,
    DWORD uFlags
);

[DllImport("COMCTL32.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern void DrawStatusTextW(
    IntPtr hDC,   // HDC
    IntPtr lprc,   // RECT* in/out
    [MarshalAs(UnmanagedType.LPWStr)] string pszText,   // LPCWSTR
    uint uFlags   // DWORD
);

<DllImport("COMCTL32.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Sub DrawStatusTextW(
    hDC As IntPtr,   ' HDC
    lprc As IntPtr,   ' RECT* in/out
    <MarshalAs(UnmanagedType.LPWStr)> pszText As String,   ' LPCWSTR
    uFlags As UInteger   ' DWORD
)
End Sub

' hDC : HDC
' lprc : RECT* in/out
' pszText : LPCWSTR
' uFlags : DWORD
Declare PtrSafe Sub DrawStatusTextW Lib "comctl32" ( _
    ByVal hDC As LongPtr, _
    ByVal lprc As LongPtr, _
    ByVal pszText As LongPtr, _
    ByVal uFlags As Long)
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

DrawStatusTextW = ctypes.windll.comctl32.DrawStatusTextW
DrawStatusTextW.restype = None
DrawStatusTextW.argtypes = [
    wintypes.HANDLE,  # hDC : HDC
    ctypes.c_void_p,  # lprc : RECT* in/out
    wintypes.LPCWSTR,  # pszText : LPCWSTR
    wintypes.DWORD,  # uFlags : DWORD
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('COMCTL32.dll')
DrawStatusTextW = Fiddle::Function.new(
  lib['DrawStatusTextW'],
  [
    Fiddle::TYPE_VOIDP,  # hDC : HDC
    Fiddle::TYPE_VOIDP,  # lprc : RECT* in/out
    Fiddle::TYPE_VOIDP,  # pszText : LPCWSTR
    -Fiddle::TYPE_INT,  # uFlags : DWORD
  ],
  Fiddle::TYPE_VOID)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "comctl32")]
extern "system" {
    fn DrawStatusTextW(
        hDC: *mut core::ffi::c_void,  // HDC
        lprc: *mut RECT,  // RECT* in/out
        pszText: *const u16,  // LPCWSTR
        uFlags: u32  // DWORD
    );
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("COMCTL32.dll", CharSet = CharSet.Unicode)]
public static extern void DrawStatusTextW(IntPtr hDC, IntPtr lprc, [MarshalAs(UnmanagedType.LPWStr)] string pszText, uint uFlags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'COMCTL32_DrawStatusTextW' -Namespace Win32 -PassThru
# $api::DrawStatusTextW(hDC, lprc, pszText, uFlags)

#uselib "COMCTL32.dll"
#func global DrawStatusTextW "DrawStatusTextW" wptr, wptr, wptr, wptr
; DrawStatusTextW hDC, varptr(lprc), pszText, uFlags
; hDC : HDC -> "wptr"
; lprc : RECT* in/out -> "wptr"
; pszText : LPCWSTR -> "wptr"
; uFlags : DWORD -> "wptr"

出力引数:

#uselib "COMCTL32.dll"
#func global DrawStatusTextW "DrawStatusTextW" sptr, var, wstr, int
; DrawStatusTextW hDC, lprc, pszText, uFlags
; hDC : HDC -> "sptr"
; lprc : RECT* in/out -> "var"
; pszText : LPCWSTR -> "wstr"
; uFlags : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "COMCTL32.dll"
#func global DrawStatusTextW "DrawStatusTextW" sptr, sptr, wstr, int
; DrawStatusTextW hDC, varptr(lprc), pszText, uFlags
; hDC : HDC -> "sptr"
; lprc : RECT* in/out -> "sptr"
; pszText : LPCWSTR -> "wstr"
; uFlags : DWORD -> "int"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。