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

GetWindowTextLengthA

関数
ウィンドウテキストの文字数を取得する(ANSI版)。
DLLUSER32.dll文字セットANSI (-A)呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

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

INT GetWindowTextLengthA(
    HWND hWnd
);

パラメーター

名前方向説明
hWndHWNDinウィンドウまたはコントロールへのハンドル。

戻り値の型: INT

公式ドキュメント

指定したウィンドウのタイトルバーのテキストの長さを文字数で取得します(ウィンドウにタイトルバーがある場合)。(ANSI)

戻り値

型: int

関数が成功すると、戻り値はテキストの長さ(文字数)になります。特定の条件下では、この値が実際のテキストの長さより大きくなることがあります(「解説」を参照)。

ウィンドウにテキストがない場合、戻り値は 0 になります。

関数の失敗は、戻り値が 0 で、かつ GetLastError の結果が 0 以外であることで示されます。

メモ

この関数は、最新のエラー情報をクリアしません。成功または失敗を判定するには、まず SetLastError を 0 で呼び出して最新のエラー情報をクリアし、その後 GetLastError を呼び出してください。

解説(Remarks)

対象のウィンドウが現在のプロセスによって所有されている場合、GetWindowTextLength は指定したウィンドウまたはコントロールに WM_GETTEXTLENGTH メッセージを送信します。

特定の条件下では、GetWindowTextLength 関数が実際のテキストの長さより大きい値を返すことがあります。これは ANSI と Unicode が特定の形で混在する場合に発生し、テキスト内にダブルバイト文字セット(DBCS)文字が存在する可能性をシステムが考慮することに起因します。ただし、戻り値は常に実際のテキストの長さ以上になるため、バッファの割り当ての目安として常に使用できます。この動作は、アプリケーションが ANSI 関数と、Unicode を使用するコモンダイアログの両方を使用する場合に発生することがあります。また、ウィンドウプロシージャが Unicode のウィンドウに対して ANSI 版の GetWindowTextLength を使用した場合や、ウィンドウプロシージャが ANSI のウィンドウに対して Unicode 版の GetWindowTextLength を使用した場合にも発生することがあります。ANSI および ANSI 関数の詳細については、「Conventions for Function Prototypes」を参照してください。

テキストの正確な長さを取得するには、WM_GETTEXTLB_GETTEXT、または CB_GETLBTEXT メッセージ、あるいは GetWindowText 関数を使用してください。

メモ

winuser.h ヘッダーは GetWindowTextLength をエイリアスとして定義しており、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 GetWindowTextLengthA(
    HWND hWnd
);
[DllImport("USER32.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern int GetWindowTextLengthA(
    IntPtr hWnd   // HWND
);
<DllImport("USER32.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GetWindowTextLengthA(
    hWnd As IntPtr   ' HWND
) As Integer
End Function
' hWnd : HWND
Declare PtrSafe Function GetWindowTextLengthA Lib "user32" ( _
    ByVal hWnd As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

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

lib = Fiddle.dlopen('USER32.dll')
GetWindowTextLengthA = Fiddle::Function.new(
  lib['GetWindowTextLengthA'],
  [
    Fiddle::TYPE_VOIDP,  # hWnd : HWND
  ],
  Fiddle::TYPE_INT)
#[link(name = "user32")]
extern "system" {
    fn GetWindowTextLengthA(
        hWnd: *mut core::ffi::c_void  // HWND
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("USER32.dll", CharSet = CharSet.Ansi, SetLastError = true)]
public static extern int GetWindowTextLengthA(IntPtr hWnd);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_GetWindowTextLengthA' -Namespace Win32 -PassThru
# $api::GetWindowTextLengthA(hWnd)
#uselib "USER32.dll"
#func global GetWindowTextLengthA "GetWindowTextLengthA" sptr
; GetWindowTextLengthA hWnd   ; 戻り値は stat
; hWnd : HWND -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "USER32.dll"
#cfunc global GetWindowTextLengthA "GetWindowTextLengthA" sptr
; res = GetWindowTextLengthA(hWnd)
; hWnd : HWND -> "sptr"
; INT GetWindowTextLengthA(HWND hWnd)
#uselib "USER32.dll"
#cfunc global GetWindowTextLengthA "GetWindowTextLengthA" intptr
; res = GetWindowTextLengthA(hWnd)
; hWnd : HWND -> "intptr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	user32 = windows.NewLazySystemDLL("USER32.dll")
	procGetWindowTextLengthA = user32.NewProc("GetWindowTextLengthA")
)

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

extern "user32" fn GetWindowTextLengthA(
    hWnd: ?*anyopaque // HWND
) callconv(std.os.windows.WINAPI) i32;
proc GetWindowTextLengthA(
    hWnd: pointer  # HWND
): int32 {.importc: "GetWindowTextLengthA", stdcall, dynlib: "USER32.dll".}
pragma(lib, "user32");
extern(Windows)
int GetWindowTextLengthA(
    void* hWnd   // HWND
);
ccall((:GetWindowTextLengthA, "USER32.dll"), stdcall, Int32,
      (Ptr{Cvoid},),
      hWnd)
# hWnd : HWND -> Ptr{Cvoid}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t GetWindowTextLengthA(
    void* hWnd);
]]
local user32 = ffi.load("user32")
-- user32.GetWindowTextLengthA(hWnd)
-- hWnd : HWND
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('USER32.dll');
const GetWindowTextLengthA = lib.func('__stdcall', 'GetWindowTextLengthA', 'int32_t', ['void *']);
// GetWindowTextLengthA(hWnd)
// hWnd : HWND -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("USER32.dll", {
  GetWindowTextLengthA: { parameters: ["pointer"], result: "i32" },
});
// lib.symbols.GetWindowTextLengthA(hWnd)
// hWnd : HWND -> "pointer"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t GetWindowTextLengthA(
    void* hWnd);
C, "USER32.dll");
// $ffi->GetWindowTextLengthA(hWnd);
// hWnd : HWND
// 構造体/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, W32APIOptions.ASCII_OPTIONS);
    int GetWindowTextLengthA(
        Pointer hWnd   // HWND
    );
}
@[Link("user32")]
lib LibUSER32
  fun GetWindowTextLengthA = GetWindowTextLengthA(
    hWnd : Void*   # HWND
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

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

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

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

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

関連項目

文字セット違い
公式の関連項目