Win32 API 日本語リファレンス
ホームUI.WindowsAndMessaging › InternalGetWindowText

InternalGetWindowText

関数
ウィンドウのタイトルテキストを直接取得する。
DLLUSER32.dll呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

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

INT InternalGetWindowText(
    HWND hWnd,
    LPWSTR pString,
    INT cchMaxCount
);

パラメーター

名前方向説明
hWndHWNDinテキストを含むウィンドウまたはコントロールへのハンドル。
pStringLPWSTRout

テキストを受け取るバッファ。

文字列がバッファと同じ長さ以上の場合、文字列は切り詰められ、null 文字で終端されます。

cchMaxCountINTinnull 文字を含め、バッファにコピーする最大文字数。テキストがこの上限を超える場合は切り詰められます。

戻り値の型: INT

公式ドキュメント

指定したウィンドウのタイトルバー(存在する場合)のテキストをバッファにコピーします。

戻り値

型: int

関数が成功した場合、戻り値は終端の null 文字を含まない、コピーされた文字列の長さ(文字数)です。

ウィンドウにタイトルバーまたはテキストがない場合、タイトルバーが空の場合、あるいはウィンドウまたはコントロールのハンドルが無効な場合、戻り値は 0 です。拡張エラー情報を取得するには、GetLastError を呼び出します。

解説(Remarks)

この関数は、Windows XP with Service Pack 1 (SP1) および Windows Server 2003 まで SDK のヘッダーおよびライブラリに含まれていませんでした。この関数のヘッダーファイルおよびインポートライブラリがない場合は、LoadLibrary および GetProcAddress を使用してこの関数を呼び出すことができます。

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

各言語での呼び出し定義

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

INT InternalGetWindowText(
    HWND hWnd,
    LPWSTR pString,
    INT cchMaxCount
);
[DllImport("USER32.dll", SetLastError = true, ExactSpelling = true)]
static extern int InternalGetWindowText(
    IntPtr hWnd,   // HWND
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder pString,   // LPWSTR out
    int cchMaxCount   // INT
);
<DllImport("USER32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function InternalGetWindowText(
    hWnd As IntPtr,   ' HWND
    <MarshalAs(UnmanagedType.LPWStr)> pString As System.Text.StringBuilder,   ' LPWSTR out
    cchMaxCount As Integer   ' INT
) As Integer
End Function
' hWnd : HWND
' pString : LPWSTR out
' cchMaxCount : INT
Declare PtrSafe Function InternalGetWindowText Lib "user32" ( _
    ByVal hWnd As LongPtr, _
    ByVal pString As LongPtr, _
    ByVal cchMaxCount As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

InternalGetWindowText = ctypes.windll.user32.InternalGetWindowText
InternalGetWindowText.restype = ctypes.c_int
InternalGetWindowText.argtypes = [
    wintypes.HANDLE,  # hWnd : HWND
    wintypes.LPWSTR,  # pString : LPWSTR out
    ctypes.c_int,  # cchMaxCount : INT
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('USER32.dll')
InternalGetWindowText = Fiddle::Function.new(
  lib['InternalGetWindowText'],
  [
    Fiddle::TYPE_VOIDP,  # hWnd : HWND
    Fiddle::TYPE_VOIDP,  # pString : LPWSTR out
    Fiddle::TYPE_INT,  # cchMaxCount : INT
  ],
  Fiddle::TYPE_INT)
#[link(name = "user32")]
extern "system" {
    fn InternalGetWindowText(
        hWnd: *mut core::ffi::c_void,  // HWND
        pString: *mut u16,  // LPWSTR out
        cchMaxCount: i32  // INT
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("USER32.dll", SetLastError = true)]
public static extern int InternalGetWindowText(IntPtr hWnd, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder pString, int cchMaxCount);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_InternalGetWindowText' -Namespace Win32 -PassThru
# $api::InternalGetWindowText(hWnd, pString, cchMaxCount)
#uselib "USER32.dll"
#func global InternalGetWindowText "InternalGetWindowText" sptr, sptr, sptr
; InternalGetWindowText hWnd, varptr(pString), cchMaxCount   ; 戻り値は stat
; hWnd : HWND -> "sptr"
; pString : LPWSTR out -> "sptr"
; cchMaxCount : INT -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "USER32.dll"
#cfunc global InternalGetWindowText "InternalGetWindowText" sptr, var, int
; res = InternalGetWindowText(hWnd, pString, cchMaxCount)
; hWnd : HWND -> "sptr"
; pString : LPWSTR out -> "var"
; cchMaxCount : INT -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; INT InternalGetWindowText(HWND hWnd, LPWSTR pString, INT cchMaxCount)
#uselib "USER32.dll"
#cfunc global InternalGetWindowText "InternalGetWindowText" intptr, var, int
; res = InternalGetWindowText(hWnd, pString, cchMaxCount)
; hWnd : HWND -> "intptr"
; pString : LPWSTR out -> "var"
; cchMaxCount : INT -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	user32 = windows.NewLazySystemDLL("USER32.dll")
	procInternalGetWindowText = user32.NewProc("InternalGetWindowText")
)

// hWnd (HWND), pString (LPWSTR out), cchMaxCount (INT)
r1, _, err := procInternalGetWindowText.Call(
	uintptr(hWnd),
	uintptr(pString),
	uintptr(cchMaxCount),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // INT
function InternalGetWindowText(
  hWnd: THandle;   // HWND
  pString: PWideChar;   // LPWSTR out
  cchMaxCount: Integer   // INT
): Integer; stdcall;
  external 'USER32.dll' name 'InternalGetWindowText';
result := DllCall("USER32\InternalGetWindowText"
    , "Ptr", hWnd   ; HWND
    , "Ptr", pString   ; LPWSTR out
    , "Int", cchMaxCount   ; INT
    , "Int")   ; return: INT
●InternalGetWindowText(hWnd, pString, cchMaxCount) = DLL("USER32.dll", "int InternalGetWindowText(void*, char*, int)")
# 呼び出し: InternalGetWindowText(hWnd, pString, cchMaxCount)
# hWnd : HWND -> "void*"
# pString : LPWSTR out -> "char*"
# cchMaxCount : INT -> "int"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "user32" fn InternalGetWindowText(
    hWnd: ?*anyopaque, // HWND
    pString: [*c]u16, // LPWSTR out
    cchMaxCount: i32 // INT
) callconv(std.os.windows.WINAPI) i32;
proc InternalGetWindowText(
    hWnd: pointer,  # HWND
    pString: ptr uint16,  # LPWSTR out
    cchMaxCount: int32  # INT
): int32 {.importc: "InternalGetWindowText", stdcall, dynlib: "USER32.dll".}
pragma(lib, "user32");
extern(Windows)
int InternalGetWindowText(
    void* hWnd,   // HWND
    wchar* pString,   // LPWSTR out
    int cchMaxCount   // INT
);
ccall((:InternalGetWindowText, "USER32.dll"), stdcall, Int32,
      (Ptr{Cvoid}, Ptr{UInt16}, Int32),
      hWnd, pString, cchMaxCount)
# hWnd : HWND -> Ptr{Cvoid}
# pString : LPWSTR out -> Ptr{UInt16}
# cchMaxCount : INT -> Int32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t InternalGetWindowText(
    void* hWnd,
    uint16_t* pString,
    int32_t cchMaxCount);
]]
local user32 = ffi.load("user32")
-- user32.InternalGetWindowText(hWnd, pString, cchMaxCount)
-- hWnd : HWND
-- pString : LPWSTR out
-- cchMaxCount : INT
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('USER32.dll');
const InternalGetWindowText = lib.func('__stdcall', 'InternalGetWindowText', 'int32_t', ['void *', 'uint16_t *', 'int32_t']);
// InternalGetWindowText(hWnd, pString, cchMaxCount)
// hWnd : HWND -> 'void *'
// pString : LPWSTR out -> 'uint16_t *'
// cchMaxCount : INT -> 'int32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("USER32.dll", {
  InternalGetWindowText: { parameters: ["pointer", "buffer", "i32"], result: "i32" },
});
// lib.symbols.InternalGetWindowText(hWnd, pString, cchMaxCount)
// hWnd : HWND -> "pointer"
// pString : LPWSTR out -> "buffer"
// cchMaxCount : INT -> "i32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t InternalGetWindowText(
    void* hWnd,
    uint16_t* pString,
    int32_t cchMaxCount);
C, "USER32.dll");
// $ffi->InternalGetWindowText(hWnd, pString, cchMaxCount);
// hWnd : HWND
// pString : LPWSTR out
// cchMaxCount : INT
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。
import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;

public interface User32 extends StdCallLibrary {
    User32 INSTANCE = Native.load("user32", User32.class);
    int InternalGetWindowText(
        Pointer hWnd,   // HWND
        char[] pString,   // LPWSTR out
        int cchMaxCount   // INT
    );
}
@[Link("user32")]
lib LibUSER32
  fun InternalGetWindowText = InternalGetWindowText(
    hWnd : Void*,   # HWND
    pString : UInt16*,   # LPWSTR out
    cchMaxCount : Int32   # INT
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef InternalGetWindowTextNative = Int32 Function(Pointer<Void>, Pointer<Utf16>, Int32);
typedef InternalGetWindowTextDart = int Function(Pointer<Void>, Pointer<Utf16>, int);
final InternalGetWindowText = DynamicLibrary.open('USER32.dll')
    .lookupFunction<InternalGetWindowTextNative, InternalGetWindowTextDart>('InternalGetWindowText');
// hWnd : HWND -> Pointer<Void>
// pString : LPWSTR out -> Pointer<Utf16>
// cchMaxCount : INT -> Int32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function InternalGetWindowText(
  hWnd: THandle;   // HWND
  pString: PWideChar;   // LPWSTR out
  cchMaxCount: Integer   // INT
): Integer; stdcall;
  external 'USER32.dll' name 'InternalGetWindowText';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "InternalGetWindowText"
  c_InternalGetWindowText :: Ptr () -> CWString -> Int32 -> IO Int32
-- hWnd : HWND -> Ptr ()
-- pString : LPWSTR out -> CWString
-- cchMaxCount : INT -> Int32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let internalgetwindowtext =
  foreign "InternalGetWindowText"
    ((ptr void) @-> (ptr uint16_t) @-> int32_t @-> returning int32_t)
(* hWnd : HWND -> (ptr void) *)
(* pString : LPWSTR out -> (ptr uint16_t) *)
(* cchMaxCount : INT -> int32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library user32 (t "USER32.dll"))
(cffi:use-foreign-library user32)

(cffi:defcfun ("InternalGetWindowText" internal-get-window-text :convention :stdcall) :int32
  (h-wnd :pointer)   ; HWND
  (p-string :pointer)   ; LPWSTR out
  (cch-max-count :int32))   ; INT
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $InternalGetWindowText = Win32::API::More->new('USER32',
    'int InternalGetWindowText(HANDLE hWnd, LPWSTR pString, int cchMaxCount)');
# my $ret = $InternalGetWindowText->Call($hWnd, $pString, $cchMaxCount);
# hWnd : HWND -> HANDLE
# pString : LPWSTR out -> LPWSTR
# cchMaxCount : INT -> int
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目