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

SetWindowTextA

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

シグネチャ

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

BOOL SetWindowTextA(
    HWND hWnd,
    LPCSTR lpString   // optional
);

パラメーター

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

戻り値の型: BOOL

公式ドキュメント

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

戻り値

型: 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  (ANSI / -A)
#include <windows.h>

BOOL SetWindowTextA(
    HWND hWnd,
    LPCSTR lpString   // optional
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("USER32.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern bool SetWindowTextA(
    IntPtr hWnd,   // HWND
    [MarshalAs(UnmanagedType.LPStr)] string lpString   // LPCSTR optional
);
<DllImport("USER32.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function SetWindowTextA(
    hWnd As IntPtr,   ' HWND
    <MarshalAs(UnmanagedType.LPStr)> lpString As String   ' LPCSTR optional
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' hWnd : HWND
' lpString : LPCSTR optional
Declare PtrSafe Function SetWindowTextA Lib "user32" ( _
    ByVal hWnd As LongPtr, _
    ByVal lpString As String) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

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

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

var (
	user32 = windows.NewLazySystemDLL("USER32.dll")
	procSetWindowTextA = user32.NewProc("SetWindowTextA")
)

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

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

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

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

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

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

関連項目

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