ホーム › UI.WindowsAndMessaging › GetWindowTextW

GetWindowTextW

関数

ウィンドウのタイトルまたはテキストを取得する(Unicode版)。

DLLUSER32.dll文字セットUnicode (-W)呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

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

INT GetWindowTextW(
    HWND hWnd,
    LPWSTR lpString,
    INT nMaxCount
);

パラメーター

名前	型	方向	説明
hWnd	HWND	in	テキストを含むウィンドウまたはコントロールへのハンドルです。
lpString	LPWSTR	out	テキストを受け取るバッファです。文字列がバッファと同じ長さ以上の場合、文字列は切り詰められ、null 文字で終端されます。
nMaxCount	INT	in	null 文字を含め、バッファにコピーする最大文字数です。テキストがこの上限を超える場合は切り詰められます。

戻り値の型: INT

公式ドキュメント

指定したウィンドウのタイトルバーのテキスト(存在する場合)をバッファにコピーします。指定したウィンドウがコントロールの場合は、そのコントロールのテキストがコピーされます。ただし、GetWindowText は別のアプリケーションに属するコントロールのテキストを取得することはできません。(Unicode)

戻り値

型: int

関数が成功した場合、戻り値はコピーされた文字列の長さ(文字数。終端の null 文字は含みません)です。ウィンドウにタイトルバーやテキストがない場合、タイトルバーが空の場合、またはウィンドウもしくはコントロールのハンドルが無効な場合、戻り値は 0 になります。拡張エラー情報を取得するには、GetLastError を呼び出します。

この関数は、別のアプリケーションに属する edit コントロールのテキストを取得することはできません。

解説(Remarks)

対象ウィンドウが現在のプロセスによって所有されている場合、GetWindowText は指定したウィンドウまたはコントロールに WM_GETTEXT メッセージを送信します。対象ウィンドウが別のプロセスによって所有されておりキャプションを持つ場合、GetWindowText はそのウィンドウのキャプションテキストを取得します。ウィンドウにキャプションがない場合、戻り値は空文字列になります。この動作は意図的なものです。これにより、対象ウィンドウを所有するプロセスが応答していない場合でも、アプリケーションは応答不能になることなく GetWindowText を呼び出すことができます。ただし、対象ウィンドウが応答しておらず、かつそれが呼び出し元のアプリケーションに属している場合、GetWindowText は呼び出し元のアプリケーションを応答不能にします。

別のプロセスにあるコントロールのテキストを取得するには、GetWindowText を呼び出すのではなく、WM_GETTEXT メッセージを直接送信してください。

例

例については、メッセージの送信を参照してください。

メモ

winuser.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして GetWindowText を定義します。エンコーディング非依存のエイリアスの使用と、エンコーディング非依存でないコードを混在させると、コンパイルエラーや実行時エラーを引き起こす不整合が生じる可能性があります。詳細については、関数プロトタイプの規約を参照してください。

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

各言語での呼び出し定義

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

INT GetWindowTextW(
    HWND hWnd,
    LPWSTR lpString,
    INT nMaxCount
);

[DllImport("USER32.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern int GetWindowTextW(
    IntPtr hWnd,   // HWND
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder lpString,   // LPWSTR out
    int nMaxCount   // INT
);

<DllImport("USER32.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GetWindowTextW(
    hWnd As IntPtr,   ' HWND
    <MarshalAs(UnmanagedType.LPWStr)> lpString As System.Text.StringBuilder,   ' LPWSTR out
    nMaxCount As Integer   ' INT
) As Integer
End Function

' hWnd : HWND
' lpString : LPWSTR out
' nMaxCount : INT
Declare PtrSafe Function GetWindowTextW Lib "user32" ( _
    ByVal hWnd As LongPtr, _
    ByVal lpString As LongPtr, _
    ByVal nMaxCount As Long) 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

GetWindowTextW = ctypes.windll.user32.GetWindowTextW
GetWindowTextW.restype = ctypes.c_int
GetWindowTextW.argtypes = [
    wintypes.HANDLE,  # hWnd : HWND
    wintypes.LPWSTR,  # lpString : LPWSTR out
    ctypes.c_int,  # nMaxCount : INT
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('USER32.dll')
GetWindowTextW = Fiddle::Function.new(
  lib['GetWindowTextW'],
  [
    Fiddle::TYPE_VOIDP,  # hWnd : HWND
    Fiddle::TYPE_VOIDP,  # lpString : LPWSTR out
    Fiddle::TYPE_INT,  # nMaxCount : INT
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "user32")]
extern "system" {
    fn GetWindowTextW(
        hWnd: *mut core::ffi::c_void,  // HWND
        lpString: *mut u16,  // LPWSTR out
        nMaxCount: i32  // INT
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("USER32.dll", CharSet = CharSet.Unicode, SetLastError = true)]
public static extern int GetWindowTextW(IntPtr hWnd, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder lpString, int nMaxCount);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_GetWindowTextW' -Namespace Win32 -PassThru
# $api::GetWindowTextW(hWnd, lpString, nMaxCount)

#uselib "USER32.dll"
#func global GetWindowTextW "GetWindowTextW" wptr, wptr, wptr
; GetWindowTextW hWnd, varptr(lpString), nMaxCount   ; 戻り値は stat
; hWnd : HWND -> "wptr"
; lpString : LPWSTR out -> "wptr"
; nMaxCount : INT -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "USER32.dll"
#cfunc global GetWindowTextW "GetWindowTextW" sptr, var, int
; res = GetWindowTextW(hWnd, lpString, nMaxCount)
; hWnd : HWND -> "sptr"
; lpString : LPWSTR out -> "var"
; nMaxCount : INT -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "USER32.dll"
#cfunc global GetWindowTextW "GetWindowTextW" sptr, sptr, int
; res = GetWindowTextW(hWnd, varptr(lpString), nMaxCount)
; hWnd : HWND -> "sptr"
; lpString : LPWSTR out -> "sptr"
; nMaxCount : INT -> "int"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。