GetWindowText

Important:
This is retired content. This content is outdated and is no longer being maintained. It is provided as a courtesy for individuals who are still using these technologies. This content may contain URLs that were valid when originally published, but now link to sites or pages that no longer exist.

This function copies the text of the specified window's title bar—if it has one—into a buffer. If the specified window is a control, the text of the control is copied. A remote application interface (RAPI) version of this function exists, and it is called CeGetWindowText.

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

Parameters

hWnd

Handle to the window or control containing the text.

lpString

Long pointer to the buffer that will receive the text.

nMaxCount

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 Values

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

When working with RAPI for Windows CE versions 1.0 and 1.01, use the PegGetWindowTextfunction.

If the target window is owned by the current process, GetWindowTextcauses a WM_GETTEXTmessage to be sent to the specified window or control. If the target window is owned by another process and has a caption, GetWindowTextretrieves the window caption text. If the window does not have a caption, the return value is a null string.

Requirements

Runs on	Versions	Defined in	Include	Link to
Windows CE OS	1.0 and later	Winuser.h

Note This API is part of the complete Windows CE OS package as provided by Microsoft. The functionality of a particular platform is determined by the original equipment manufacturer (OEM) and some devices may not support this API.