GetDlgItemTextA function

Retrieves the title or text associated with a control in a dialog box.

Syntax

UINT GetDlgItemTextA(
  HWND  hDlg,
  int   nIDDlgItem,
  LPSTR lpString,
  int   cchMax
);

Parameters

hDlg

Type: HWND

A handle to the dialog box that contains the control.

nIDDlgItem

Type: int

The identifier of the control whose title or text is to be retrieved.

lpString

Type: LPTSTR

The buffer to receive the title or text.

cchMax

Type: int

The maximum length, in characters, of the string to be copied to the buffer pointed to by lpString. If the length of the string, including the null character, exceeds the limit, the string is truncated.

Return Value

Type: UINT

If the function succeeds, the return value specifies the number of characters copied to the buffer, not including the terminating null character.

If the function fails, the return value is zero. To get extended error information, call GetLastError.

Remarks

If the string is as long or longer than the buffer, the buffer will contain the truncated string with a terminating null character.

The GetDlgItemText function sends a WM_GETTEXT message to the control.

Examples

For an example, see Creating a Modal Dialog Box.

Requirements

   
Windows version Windows 2000 Professional [desktop apps only] Windows 2000 Server [desktop apps only]
Target Platform Windows
Header winuser.h (include Windows.h)
Library User32.lib
DLL User32.dll

See Also

Conceptual

Dialog Boxes

GetDlgItemInt

Reference

SetDlgItemInt

SetDlgItemText

WM_GETTEXT