GetWindowText (Compact 2013)

  • Article

3/28/2014

Syntax

int GetWindowText( 
  HWND hWnd, 
  LPTSTR lpString, 
  int nMaxCount 
);

Parameters

  • hWnd
    [in] Handle to the window or control containing the text.
  • lpString
    [out] Long pointer to the buffer that will receive the text.
  • nMaxCount
    [in] Specifies the maximum number of characters to copy to the buffer, including the NULL character. If the text exceeds this limit, it is truncated.

Return Value

The length, in characters, of the copied string, not including the terminating null character, indicates success. Zero indicates that the window has no title bar or text, if the title bar is empty, or if the window or control handle is invalid. To get extended error information, call GetLastError.

This function cannot retrieve the text of an edit control in another application.

Remarks

GetWindowText causes a WM_GETTEXT message to be sent to the specified window or control.

Note

If specified window is a cross process window and it does not handle messages, the call will be blocked indefinitely.

If the window does not have a caption, the return value is a null string.

Requirements

Header

winuser.h

See Also

Reference

Window Functions
GetWindowTextLength
SetWindowText
WM_GETTEXT