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

SetWindowTextW

関数
ウィンドウのタイトルまたはテキストを設定する(Unicode版)。
DLLUSER32.dll文字セットUnicode (-W)呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

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

BOOL SetWindowTextW(
    HWND hWnd,
    LPCWSTR lpString   // optional
);

パラメーター

名前方向説明
hWndHWNDinテキストを変更するウィンドウまたはコントロールへのハンドル。
lpStringLPCWSTRinoptional新しいタイトルまたはコントロールのテキスト。

戻り値の型: BOOL

公式ドキュメント

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

戻り値

型: BOOL

関数が成功した場合、戻り値は 0 以外の値です。

関数が失敗した場合、戻り値は 0 です。拡張エラー情報を取得するには、GetLastError を呼び出します。

解説(Remarks)

対象のウィンドウが現在のプロセスによって所有されている場合、SetWindowText は指定されたウィンドウまたはコントロールに WM_SETTEXT メッセージを送信します。ただし、コントロールが WS_CAPTION スタイルで作成されたリストボックスコントロールの場合、SetWindowText はリストボックスの項目ではなくコントロールのテキストを設定します。

別のプロセスのコントロールのテキストを設定するには、SetWindowText を呼び出す代わりに、WM_SETTEXT メッセージを直接送信してください。

SetWindowText 関数はタブ文字(ASCII コード 0x09)を展開しません。タブ文字は縦棒(|)文字として表示されます。

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

メモ

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

出典・ライセンス: 上記「公式ドキュメント」の内容は 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>

BOOL SetWindowTextW(
    HWND hWnd,
    LPCWSTR lpString   // optional
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("USER32.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern bool SetWindowTextW(
    IntPtr hWnd,   // HWND
    [MarshalAs(UnmanagedType.LPWStr)] string lpString   // LPCWSTR optional
);
<DllImport("USER32.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function SetWindowTextW(
    hWnd As IntPtr,   ' HWND
    <MarshalAs(UnmanagedType.LPWStr)> lpString As String   ' LPCWSTR optional
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' hWnd : HWND
' lpString : LPCWSTR optional
Declare PtrSafe Function SetWindowTextW Lib "user32" ( _
    ByVal hWnd As LongPtr, _
    ByVal lpString 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

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

lib = Fiddle.dlopen('USER32.dll')
SetWindowTextW = Fiddle::Function.new(
  lib['SetWindowTextW'],
  [
    Fiddle::TYPE_VOIDP,  # hWnd : HWND
    Fiddle::TYPE_VOIDP,  # lpString : LPCWSTR optional
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "user32")]
extern "system" {
    fn SetWindowTextW(
        hWnd: *mut core::ffi::c_void,  // HWND
        lpString: *const u16  // LPCWSTR optional
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("USER32.dll", CharSet = CharSet.Unicode, SetLastError = true)]
public static extern bool SetWindowTextW(IntPtr hWnd, [MarshalAs(UnmanagedType.LPWStr)] string lpString);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_SetWindowTextW' -Namespace Win32 -PassThru
# $api::SetWindowTextW(hWnd, lpString)
#uselib "USER32.dll"
#func global SetWindowTextW "SetWindowTextW" wptr, wptr
; SetWindowTextW hWnd, lpString   ; 戻り値は stat
; hWnd : HWND -> "wptr"
; lpString : LPCWSTR optional -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "USER32.dll"
#cfunc global SetWindowTextW "SetWindowTextW" sptr, wstr
; res = SetWindowTextW(hWnd, lpString)
; hWnd : HWND -> "sptr"
; lpString : LPCWSTR optional -> "wstr"
; BOOL SetWindowTextW(HWND hWnd, LPCWSTR lpString)
#uselib "USER32.dll"
#cfunc global SetWindowTextW "SetWindowTextW" intptr, wstr
; res = SetWindowTextW(hWnd, lpString)
; hWnd : HWND -> "intptr"
; lpString : LPCWSTR optional -> "wstr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	user32 = windows.NewLazySystemDLL("USER32.dll")
	procSetWindowTextW = user32.NewProc("SetWindowTextW")
)

// hWnd (HWND), lpString (LPCWSTR optional)
r1, _, err := procSetWindowTextW.Call(
	uintptr(hWnd),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(lpString))),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function SetWindowTextW(
  hWnd: THandle;   // HWND
  lpString: PWideChar   // LPCWSTR optional
): BOOL; stdcall;
  external 'USER32.dll' name 'SetWindowTextW';
result := DllCall("USER32\SetWindowTextW"
    , "Ptr", hWnd   ; HWND
    , "WStr", lpString   ; LPCWSTR optional
    , "Int")   ; return: BOOL
●SetWindowTextW(hWnd, lpString) = DLL("USER32.dll", "bool SetWindowTextW(void*, char*)")
# 呼び出し: SetWindowTextW(hWnd, lpString)
# hWnd : HWND -> "void*"
# lpString : LPCWSTR optional -> "char*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。
const std = @import("std");

extern "user32" fn SetWindowTextW(
    hWnd: ?*anyopaque, // HWND
    lpString: [*c]const u16 // LPCWSTR optional
) callconv(std.os.windows.WINAPI) i32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc SetWindowTextW(
    hWnd: pointer,  # HWND
    lpString: WideCString  # LPCWSTR optional
): int32 {.importc: "SetWindowTextW", stdcall, dynlib: "USER32.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "user32");
extern(Windows)
int SetWindowTextW(
    void* hWnd,   // HWND
    const(wchar)* lpString   // LPCWSTR optional
);
ccall((:SetWindowTextW, "USER32.dll"), stdcall, Int32,
      (Ptr{Cvoid}, Cwstring),
      hWnd, lpString)
# hWnd : HWND -> Ptr{Cvoid}
# lpString : LPCWSTR optional -> Cwstring
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
int32_t SetWindowTextW(
    void* hWnd,
    const uint16_t* lpString);
]]
local user32 = ffi.load("user32")
-- user32.SetWindowTextW(hWnd, lpString)
-- hWnd : HWND
-- lpString : LPCWSTR optional
-- 構造体/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 SetWindowTextW = lib.func('__stdcall', 'SetWindowTextW', 'int32_t', ['void *', 'str16']);
// SetWindowTextW(hWnd, lpString)
// hWnd : HWND -> 'void *'
// lpString : LPCWSTR optional -> 'str16'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("USER32.dll", {
  SetWindowTextW: { parameters: ["pointer", "buffer"], result: "i32" },
});
// lib.symbols.SetWindowTextW(hWnd, lpString)
// hWnd : HWND -> "pointer"
// lpString : LPCWSTR optional -> "buffer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t SetWindowTextW(
    void* hWnd,
    const uint16_t* lpString);
C, "USER32.dll");
// $ffi->SetWindowTextW(hWnd, lpString);
// hWnd : HWND
// lpString : LPCWSTR optional
// 構造体/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);
    boolean SetWindowTextW(
        Pointer hWnd,   // HWND
        WString lpString   // LPCWSTR optional
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("user32")]
lib LibUSER32
  fun SetWindowTextW = SetWindowTextW(
    hWnd : Void*,   # HWND
    lpString : UInt16*   # LPCWSTR optional
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

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

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

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

(cffi:defcfun ("SetWindowTextW" set-window-text-w :convention :stdcall) :int32
  (h-wnd :pointer)   ; HWND
  (lp-string (:string :encoding :utf-16le)))   ; LPCWSTR optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SetWindowTextW = Win32::API::More->new('USER32',
    'BOOL SetWindowTextW(HANDLE hWnd, LPCWSTR lpString)');
# my $ret = $SetWindowTextW->Call($hWnd, $lpString);
# hWnd : HWND -> HANDLE
# lpString : LPCWSTR optional -> LPCWSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

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