ホーム › UI.WindowsAndMessaging › GetWindowTextA

GetWindowTextA

関数

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

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

シグネチャ

// USER32.dll  (ANSI / -A)
#include <windows.h>

INT GetWindowTextA(
    HWND hWnd,
    LPSTR lpString,
    INT nMaxCount
);

パラメーター

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

戻り値の型: INT

公式ドキュメント

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

戻り値

型: int

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

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

解説(Remarks)

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

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

Examples

次のサンプルコードは、GetWindowTextA の呼び出し例を示しています。

hwndCombo = GetDlgItem(hwndDlg, IDD_COMBO); 
cTxtLen = GetWindowTextLength(hwndCombo); 

// Allocate memory for the string and copy 
// the string into the memory. 

pszMem = (PSTR) VirtualAlloc((LPVOID) NULL, 
    (DWORD) (cTxtLen + 1), MEM_COMMIT, 
    PAGE_READWRITE); 
GetWindowText(hwndCombo, pszMem, 
    cTxtLen + 1);

このサンプルを文脈の中で確認するには、Sending a Message を参照してください。

メモ

winuser.h ヘッダーは、GetWindowText を、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)

各言語での呼び出し定義

// USER32.dll  (ANSI / -A)
#include <windows.h>

INT GetWindowTextA(
    HWND hWnd,
    LPSTR lpString,
    INT nMaxCount
);

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

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

' hWnd : HWND
' lpString : LPSTR out
' nMaxCount : INT
Declare PtrSafe Function GetWindowTextA Lib "user32" ( _
    ByVal hWnd As LongPtr, _
    ByVal lpString As String, _
    ByVal nMaxCount As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

GetWindowTextA = ctypes.windll.user32.GetWindowTextA
GetWindowTextA.restype = ctypes.c_int
GetWindowTextA.argtypes = [
    wintypes.HANDLE,  # hWnd : HWND
    wintypes.LPSTR,  # lpString : LPSTR 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')
GetWindowTextA = Fiddle::Function.new(
  lib['GetWindowTextA'],
  [
    Fiddle::TYPE_VOIDP,  # hWnd : HWND
    Fiddle::TYPE_VOIDP,  # lpString : LPSTR out
    Fiddle::TYPE_INT,  # nMaxCount : INT
  ],
  Fiddle::TYPE_INT)

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

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

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

出力引数:

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