GetDlgItemText

A version of this page is also available for

Windows Embedded CE 6.0 R3

4/8/2010

This function retrieves the title or text associated with a control in a dialog box.

Syntax

UINT GetDlgItemText( 
  HWND hDlg, 
  int nIDDlgItem, 
  LPTSTR lpString, 
  int nMaxCount
); 

Parameters

• hDlg
  [in] Handle to the dialog box that contains the control.

• nIDDlgItem
  [in] Specifies the identifier of the control whose title or text is to be retrieved.

• lpString
  [out] Long pointer to the buffer to receive the title or text.

• nMaxCount
  [in] Specifies the maximum length, in characters, of the string to be copied to the buffer pointed to by lpString. If the length of the string exceeds the limit, the string is truncated.

Return Value

The number of characters copied to the buffer, not including the terminating null character, indicates success. Zero indicates failure. To get extended error information, call GetLastError.

Remarks

The GetDlgItemText function sends a WM_GETTEXT message to the control.

Requirements

See Also

Reference

GetDlgItemInt
SetDlgItemInt
SetDlgItemText
WM_GETTEXT
Dialog Boxes Functions