windows_programming_notes.nbk: Home | Index | Next Page: GetEnvironmentStrings | Previous Page: GetDlgItemInt

 GetDlgItemText

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

UINT GetDlgItemText(
  HWND hDlg,       // handle to dialog box
  int nIDDlgItem,  // control identifier
  LPTSTR lpString, // pointer to buffer for text
  int nMaxCount    // maximum size of string
);

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] Pointer to the buffer to receive the title or text.
• nMaxCount
  [in] Specifies the maximum length, in TCHARs, 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 Values

If the function succeeds, the return value specifies the number of TCHARs 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

The GetDlgItemText function sends a WM_GETTEXT message to the control.

For the ANSI version of the function, the number of TCHARs is the number of bytes; for the Unicode version, it is the number of characters.

windows_programming_notes.nbk: Home | Index | Next Page: GetEnvironmentStrings | Previous Page: GetDlgItemInt

Notebook exported on Monday, 7 July 2008, 18:56:50 PM Eastern Daylight Time