GetDlgItemTextA 関数 (winuser.h)

  • [アーティクル]

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

構文

UINT GetDlgItemTextA(
  [in]  HWND  hDlg,
  [in]  int   nIDDlgItem,
  [out] LPSTR lpString,
  [in]  int   cchMax
);

パラメーター

[in] hDlg

型: HWND

コントロールを含むダイアログ ボックスのハンドル。

[in] nIDDlgItem

型: int

タイトルまたはテキストを取得するコントロールの識別子。

[out] lpString

種類: LPTSTR

タイトルまたはテキストを受け取るバッファー。

[in] cchMax

型: int

lpString が指すバッファーにコピーされる文字列の最大長 (文字数)。 null 文字を含む文字列の長さが制限を超えると、文字列は切り捨てられます。

戻り値

型: UINT

関数が成功した場合、戻り値は、終端の null 文字を含めず、バッファーにコピーされる文字数を指定します。

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

解説

文字列がバッファーより長いまたは長い場合、バッファーには、終端の null 文字を含む切り捨てられた文字列が含まれます。

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

例

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

注意

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

要件

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

関連項目

概念

ダイアログ ボックス

GetDlgItemInt

リファレンス

SetDlgItemInt

SetDlgItemText

WM_GETTEXT