ホーム › UI.WindowsAndMessaging › GetDlgItemTextW

GetDlgItemTextW

関数

ダイアログコントロールのテキストを取得する(Unicode)。

DLLUSER32.dll文字セットUnicode (-W)呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

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

DWORD GetDlgItemTextW(
    HWND hDlg,
    INT nIDDlgItem,
    LPWSTR lpString,
    INT cchMax
);

パラメーター

名前	型	方向	説明
hDlg	HWND	in	コントロールを含むダイアログボックスへのハンドル。
nIDDlgItem	INT	in	タイトルまたはテキストを取得するコントロールの識別子。
lpString	LPWSTR	out	タイトルまたはテキストを受け取るバッファー。
cchMax	INT	in	lpString が指すバッファーにコピーする文字列の最大長(文字数)。null 文字を含む文字列の長さがこの上限を超える場合、文字列は切り詰められます。

戻り値の型: DWORD

公式ドキュメント

ダイアログボックス内のコントロールに関連付けられたタイトルまたはテキストを取得します。(Unicode)

戻り値

型: UINT

関数が成功した場合、戻り値はバッファーにコピーされた文字数(終端の null 文字を含まない)を表します。

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

解説(Remarks)

文字列がバッファーと同じ長さかそれより長い場合、バッファーには切り詰められた文字列と終端の null 文字が格納されます。

GetDlgItemText 関数は、コントロールに WM_GETTEXT メッセージを送信します。

例

例については、モーダルダイアログボックスの作成を参照してください。

メモ

winuser.h ヘッダーは、GetDlgItemText を、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>

DWORD GetDlgItemTextW(
    HWND hDlg,
    INT nIDDlgItem,
    LPWSTR lpString,
    INT cchMax
);

[DllImport("USER32.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern uint GetDlgItemTextW(
    IntPtr hDlg,   // HWND
    int nIDDlgItem,   // INT
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder lpString,   // LPWSTR out
    int cchMax   // INT
);

<DllImport("USER32.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GetDlgItemTextW(
    hDlg As IntPtr,   ' HWND
    nIDDlgItem As Integer,   ' INT
    <MarshalAs(UnmanagedType.LPWStr)> lpString As System.Text.StringBuilder,   ' LPWSTR out
    cchMax As Integer   ' INT
) As UInteger
End Function

' hDlg : HWND
' nIDDlgItem : INT
' lpString : LPWSTR out
' cchMax : INT
Declare PtrSafe Function GetDlgItemTextW Lib "user32" ( _
    ByVal hDlg As LongPtr, _
    ByVal nIDDlgItem As Long, _
    ByVal lpString As LongPtr, _
    ByVal cchMax As Long) 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

GetDlgItemTextW = ctypes.windll.user32.GetDlgItemTextW
GetDlgItemTextW.restype = wintypes.DWORD
GetDlgItemTextW.argtypes = [
    wintypes.HANDLE,  # hDlg : HWND
    ctypes.c_int,  # nIDDlgItem : INT
    wintypes.LPWSTR,  # lpString : LPWSTR out
    ctypes.c_int,  # cchMax : INT
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('USER32.dll')
GetDlgItemTextW = Fiddle::Function.new(
  lib['GetDlgItemTextW'],
  [
    Fiddle::TYPE_VOIDP,  # hDlg : HWND
    Fiddle::TYPE_INT,  # nIDDlgItem : INT
    Fiddle::TYPE_VOIDP,  # lpString : LPWSTR out
    Fiddle::TYPE_INT,  # cchMax : INT
  ],
  -Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "user32")]
extern "system" {
    fn GetDlgItemTextW(
        hDlg: *mut core::ffi::c_void,  // HWND
        nIDDlgItem: i32,  // INT
        lpString: *mut u16,  // LPWSTR out
        cchMax: i32  // INT
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("USER32.dll", CharSet = CharSet.Unicode, SetLastError = true)]
public static extern uint GetDlgItemTextW(IntPtr hDlg, int nIDDlgItem, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder lpString, int cchMax);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_GetDlgItemTextW' -Namespace Win32 -PassThru
# $api::GetDlgItemTextW(hDlg, nIDDlgItem, lpString, cchMax)

#uselib "USER32.dll"
#func global GetDlgItemTextW "GetDlgItemTextW" wptr, wptr, wptr, wptr
; GetDlgItemTextW hDlg, nIDDlgItem, varptr(lpString), cchMax   ; 戻り値は stat
; hDlg : HWND -> "wptr"
; nIDDlgItem : INT -> "wptr"
; lpString : LPWSTR out -> "wptr"
; cchMax : INT -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "USER32.dll"
#cfunc global GetDlgItemTextW "GetDlgItemTextW" sptr, int, var, int
; res = GetDlgItemTextW(hDlg, nIDDlgItem, lpString, cchMax)
; hDlg : HWND -> "sptr"
; nIDDlgItem : INT -> "int"
; lpString : LPWSTR out -> "var"
; cchMax : INT -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "USER32.dll"
#cfunc global GetDlgItemTextW "GetDlgItemTextW" sptr, int, sptr, int
; res = GetDlgItemTextW(hDlg, nIDDlgItem, varptr(lpString), cchMax)
; hDlg : HWND -> "sptr"
; nIDDlgItem : INT -> "int"
; lpString : LPWSTR out -> "sptr"
; cchMax : INT -> "int"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。