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

SetDlgItemTextW

関数
ダイアログコントロールのテキストを設定する(Unicode)。
DLLUSER32.dll文字セットUnicode (-W)呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

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

BOOL SetDlgItemTextW(
    HWND hDlg,
    INT nIDDlgItem,
    LPCWSTR lpString
);

パラメーター

名前方向説明
hDlgHWNDinコントロールを含むダイアログボックスのハンドル。
nIDDlgItemINTinタイトルまたはテキストを設定するコントロール。
lpStringLPCWSTRinコントロールにコピーするテキスト。

戻り値の型: BOOL

公式ドキュメント

ダイアログボックス内のコントロールのタイトルまたはテキストを設定します。(Unicode)

戻り値

型: BOOL

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

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

解説(Remarks)

SetDlgItemText 関数は、指定されたコントロールに WM_SETTEXT メッセージを送信します。

例については、Using List Boxes を参照してください。

メモ

winuser.h ヘッダーは、SetDlgItemText をエイリアスとして定義しており、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  (Unicode / -W)
#include <windows.h>

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

SetDlgItemTextW = ctypes.windll.user32.SetDlgItemTextW
SetDlgItemTextW.restype = wintypes.BOOL
SetDlgItemTextW.argtypes = [
    wintypes.HANDLE,  # hDlg : HWND
    ctypes.c_int,  # nIDDlgItem : INT
    wintypes.LPCWSTR,  # lpString : LPCWSTR
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('USER32.dll')
SetDlgItemTextW = Fiddle::Function.new(
  lib['SetDlgItemTextW'],
  [
    Fiddle::TYPE_VOIDP,  # hDlg : HWND
    Fiddle::TYPE_INT,  # nIDDlgItem : INT
    Fiddle::TYPE_VOIDP,  # lpString : LPCWSTR
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "user32")]
extern "system" {
    fn SetDlgItemTextW(
        hDlg: *mut core::ffi::c_void,  // HWND
        nIDDlgItem: i32,  // INT
        lpString: *const u16  // LPCWSTR
    ) -> 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 SetDlgItemTextW(IntPtr hDlg, int nIDDlgItem, [MarshalAs(UnmanagedType.LPWStr)] string lpString);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_SetDlgItemTextW' -Namespace Win32 -PassThru
# $api::SetDlgItemTextW(hDlg, nIDDlgItem, lpString)
#uselib "USER32.dll"
#func global SetDlgItemTextW "SetDlgItemTextW" wptr, wptr, wptr
; SetDlgItemTextW hDlg, nIDDlgItem, lpString   ; 戻り値は stat
; hDlg : HWND -> "wptr"
; nIDDlgItem : INT -> "wptr"
; lpString : LPCWSTR -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "USER32.dll"
#cfunc global SetDlgItemTextW "SetDlgItemTextW" sptr, int, wstr
; res = SetDlgItemTextW(hDlg, nIDDlgItem, lpString)
; hDlg : HWND -> "sptr"
; nIDDlgItem : INT -> "int"
; lpString : LPCWSTR -> "wstr"
; BOOL SetDlgItemTextW(HWND hDlg, INT nIDDlgItem, LPCWSTR lpString)
#uselib "USER32.dll"
#cfunc global SetDlgItemTextW "SetDlgItemTextW" intptr, int, wstr
; res = SetDlgItemTextW(hDlg, nIDDlgItem, lpString)
; hDlg : HWND -> "intptr"
; nIDDlgItem : INT -> "int"
; lpString : LPCWSTR -> "wstr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	user32 = windows.NewLazySystemDLL("USER32.dll")
	procSetDlgItemTextW = user32.NewProc("SetDlgItemTextW")
)

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

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

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

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

let setdlgitemtextw =
  foreign "SetDlgItemTextW"
    ((ptr void) @-> int32_t @-> (ptr uint16_t) @-> returning int32_t)
(* hDlg : HWND -> (ptr void) *)
(* nIDDlgItem : INT -> int32_t *)
(* lpString : LPCWSTR -> (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 ("SetDlgItemTextW" set-dlg-item-text-w :convention :stdcall) :int32
  (h-dlg :pointer)   ; HWND
  (n-iddlg-item :int32)   ; INT
  (lp-string (:string :encoding :utf-16le)))   ; LPCWSTR
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SetDlgItemTextW = Win32::API::More->new('USER32',
    'BOOL SetDlgItemTextW(HANDLE hDlg, int nIDDlgItem, LPCWSTR lpString)');
# my $ret = $SetDlgItemTextW->Call($hDlg, $nIDDlgItem, $lpString);
# hDlg : HWND -> HANDLE
# nIDDlgItem : INT -> int
# lpString : LPCWSTR -> LPCWSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

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