SetWindowTextA 関数 (winuser.h)

  • [アーティクル]

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

構文

BOOL SetWindowTextA(
  [in]           HWND   hWnd,
  [in, optional] LPCSTR lpString
);

パラメーター

[in] hWnd

型: HWND

テキストを変更するウィンドウまたはコントロールへのハンドル。

[in, optional] lpString

型: LPCTSTR

新しいタイトルまたはコントロール テキスト。

戻り値

種類: BOOL

関数が成功すると、戻り値は 0 以外になります。

関数が失敗した場合は、0 を返します。 詳細なエラー情報を得るには、GetLastError を呼び出します。

解説

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

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

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

例

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

注意

winuser.h ヘッダーは、Unicode プリプロセッサ定数の定義に基づいて、この関数の ANSI または Unicode バージョンを自動的に選択するエイリアスとして SetWindowText を定義します。 encoding-neutral エイリアスの使用を encoding-neutral ではないコードと混在すると、コンパイル エラーまたはランタイム エラーが発生する不一致が発生する可能性があります。 詳細については、「 関数プロトタイプの規則」を参照してください。

要件

要件 値
サポートされている最小のクライアント Windows 2000 Professional [デスクトップ アプリのみ]
サポートされている最小のサーバー Windows 2000 Server [デスクトップ アプリのみ]
対象プラットフォーム Windows
ヘッダー winuser.h (Windows.h を含む)
Library User32.lib
[DLL] User32.dll
API セット ext-ms-win-ntuser-window-l1-1-3 (Windows 10 バージョン 10.0.10240 で導入)

関連項目

概念

GetWindowText

リファレンス

WM_SETTEXT

Windows