GetWindowTextLengthW
関数シグネチャ
// USER32.dll (Unicode / -W)
#include <windows.h>
INT GetWindowTextLengthW(
HWND hWnd
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| hWnd | HWND | in | ウィンドウまたはコントロールへのハンドルです。 |
戻り値の型: INT
公式ドキュメント
指定したウィンドウのタイトルバーテキストの長さを、文字数単位で取得します(ウィンドウにタイトルバーがある場合)。(Unicode)
戻り値
型: 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_GETTEXT、LB_GETTEXT、または CB_GETLBTEXT メッセージ、あるいは GetWindowText 関数を使用してください。
winuser.h ヘッダーは GetWindowTextLength をエイリアスとして定義しており、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版が自動的に選択されます。エンコーディング中立のエイリアスの使用を、エンコーディング中立でないコードと混在させると、不整合が生じてコンパイルエラーまたは実行時エラーの原因となることがあります。詳細については、Conventions for Function Prototypes を参照してください。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// USER32.dll (Unicode / -W)
#include <windows.h>
INT GetWindowTextLengthW(
HWND hWnd
);[DllImport("USER32.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern int GetWindowTextLengthW(
IntPtr hWnd // HWND
);<DllImport("USER32.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GetWindowTextLengthW(
hWnd As IntPtr ' HWND
) As Integer
End Function' hWnd : HWND
Declare PtrSafe Function GetWindowTextLengthW Lib "user32" ( _
ByVal hWnd As LongPtr) 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
GetWindowTextLengthW = ctypes.windll.user32.GetWindowTextLengthW
GetWindowTextLengthW.restype = ctypes.c_int
GetWindowTextLengthW.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')
GetWindowTextLengthW = Fiddle::Function.new(
lib['GetWindowTextLengthW'],
[
Fiddle::TYPE_VOIDP, # hWnd : HWND
],
Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"#[link(name = "user32")]
extern "system" {
fn GetWindowTextLengthW(
hWnd: *mut core::ffi::c_void // HWND
) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.$sig = @"
[DllImport("USER32.dll", CharSet = CharSet.Unicode, SetLastError = true)]
public static extern int GetWindowTextLengthW(IntPtr hWnd);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_GetWindowTextLengthW' -Namespace Win32 -PassThru
# $api::GetWindowTextLengthW(hWnd)#uselib "USER32.dll"
#func global GetWindowTextLengthW "GetWindowTextLengthW" wptr
; GetWindowTextLengthW hWnd ; 戻り値は stat
; hWnd : HWND -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "USER32.dll"
#cfunc global GetWindowTextLengthW "GetWindowTextLengthW" sptr
; res = GetWindowTextLengthW(hWnd)
; hWnd : HWND -> "sptr"; INT GetWindowTextLengthW(HWND hWnd)
#uselib "USER32.dll"
#cfunc global GetWindowTextLengthW "GetWindowTextLengthW" intptr
; res = GetWindowTextLengthW(hWnd)
; hWnd : HWND -> "intptr"import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
user32 = windows.NewLazySystemDLL("USER32.dll")
procGetWindowTextLengthW = user32.NewProc("GetWindowTextLengthW")
)
// hWnd (HWND)
r1, _, err := procGetWindowTextLengthW.Call(
uintptr(hWnd),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // INTfunction GetWindowTextLengthW(
hWnd: THandle // HWND
): Integer; stdcall;
external 'USER32.dll' name 'GetWindowTextLengthW';result := DllCall("USER32\GetWindowTextLengthW"
, "Ptr", hWnd ; HWND
, "Int") ; return: INT●GetWindowTextLengthW(hWnd) = DLL("USER32.dll", "int GetWindowTextLengthW(void*)")
# 呼び出し: GetWindowTextLengthW(hWnd)
# hWnd : HWND -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。const std = @import("std");
extern "user32" fn GetWindowTextLengthW(
hWnd: ?*anyopaque // HWND
) callconv(std.os.windows.WINAPI) i32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。proc GetWindowTextLengthW(
hWnd: pointer # HWND
): int32 {.importc: "GetWindowTextLengthW", stdcall, dynlib: "USER32.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。pragma(lib, "user32");
extern(Windows)
int GetWindowTextLengthW(
void* hWnd // HWND
);ccall((:GetWindowTextLengthW, "USER32.dll"), stdcall, Int32,
(Ptr{Cvoid},),
hWnd)
# hWnd : HWND -> Ptr{Cvoid}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。local ffi = require("ffi")
ffi.cdef[[
int32_t GetWindowTextLengthW(
void* hWnd);
]]
local user32 = ffi.load("user32")
-- user32.GetWindowTextLengthW(hWnd)
-- hWnd : HWND
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- Unicode(-W): uint16_t* には UTF-16LE のバッファ(ffi.new("uint16_t[?]", ...))を渡す。const koffi = require('koffi');
const lib = koffi.load('USER32.dll');
const GetWindowTextLengthW = lib.func('__stdcall', 'GetWindowTextLengthW', 'int32_t', ['void *']);
// GetWindowTextLengthW(hWnd)
// hWnd : HWND -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("USER32.dll", {
GetWindowTextLengthW: { parameters: ["pointer"], result: "i32" },
});
// lib.symbols.GetWindowTextLengthW(hWnd)
// hWnd : HWND -> "pointer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
int32_t GetWindowTextLengthW(
void* hWnd);
C, "USER32.dll");
// $ffi->GetWindowTextLengthW(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.UNICODE_OPTIONS);
int GetWindowTextLengthW(
Pointer hWnd // HWND
);
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。@[Link("user32")]
lib LibUSER32
fun GetWindowTextLengthW = GetWindowTextLengthW(
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 GetWindowTextLengthWNative = Int32 Function(Pointer<Void>);
typedef GetWindowTextLengthWDart = int Function(Pointer<Void>);
final GetWindowTextLengthW = DynamicLibrary.open('USER32.dll')
.lookupFunction<GetWindowTextLengthWNative, GetWindowTextLengthWDart>('GetWindowTextLengthW');
// hWnd : HWND -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function GetWindowTextLengthW(
hWnd: THandle // HWND
): Integer; stdcall;
external 'USER32.dll' name 'GetWindowTextLengthW';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "GetWindowTextLengthW"
c_GetWindowTextLengthW :: Ptr () -> IO Int32
-- hWnd : HWND -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let getwindowtextlengthw =
foreign "GetWindowTextLengthW"
((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 ("GetWindowTextLengthW" get-window-text-length-w :convention :stdcall) :int32
(h-wnd :pointer)) ; HWND
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $GetWindowTextLengthW = Win32::API::More->new('USER32',
'int GetWindowTextLengthW(HANDLE hWnd)');
# my $ret = $GetWindowTextLengthW->Call($hWnd);
# hWnd : HWND -> HANDLE
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。関連項目
- f GetWindowTextLengthA (ANSI版) — ウィンドウテキストの文字数を取得する(ANSI版)。
- f GetWindowTextW — ウィンドウのタイトルまたはテキストを取得する(Unicode版)。
- f SetWindowTextW — ウィンドウのタイトルまたはテキストを設定する(Unicode版)。