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 (RAPI).
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
When working with RAPI for Windows CE 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
Header | winuser.h |
Windows Embedded CE | Windows CE 1.0 and later |
Windows Mobile | Windows Mobile Version 5.0 and later |