WinQueryWindowTextLength: Difference between revisions

Latest revision as of 07:16, 7 August 2023

This call returns the length of the window text, excluding any null termination character.

Syntax

WinQueryWindowTextLength(hwnd)

Parameters

hwnd (HWND) - input: Window handle.

Returns

lRetLen (LONG) - returns: Length of the window text.

Remarks

This function sends a WM_QUERYWINDOWPARAMS message to hwnd.

Errors

Possible returns from WinGetLastError

PMERR_INVALID_HWND (0x1001): An invalid window handle was specified.

Example Code

This example shows how to get the title-bar window text.

#define INCL_WINWINDOWMGR
#define INCL_DOSMEMMGR
#include <os2.h>

HWND   hwndFrame;
PSZ    szTitle;
ULONG  cbBytes;

cbBytes =  WinQueryWindowTextLength(hwndFrame);

DosAllocMem((PPVOID)szTitle,
            (ULONG)cbBytes,
            PAG_READ  |
            PAG_WRITE |
            PAG_COMMIT);

WinQueryWindowText(hwndFrame, sizeof(szTitle), szTitle);

Related Functions

Related Messages

WM_QUERYWINDOWPARAMS

@@ Line 1: / Line 1: @@
 This call returns the length of the window text, excluding any null termination character.
 ==Syntax==
-  WinQueryWindowTextLength(hwnd);
+  WinQueryWindowTextLength(hwnd)
 ==Parameters==
-;hwnd (HWND) - input
+;hwnd (HWND) - input:Window handle.
-:Window handle.
 ==Returns==
-;lRetLen (LONG) - returns
+;lRetLen (LONG) - returns:Length of the window text.
-:Length of the window text.
 ==Remarks==
 This function sends a WM_QUERYWINDOWPARAMS message to hwnd.
 ==Errors==
 Possible returns from WinGetLastError
-;PMERR_INVALID_HWND (0x1001)
+;PMERR_INVALID_HWND (0x1001):An invalid window handle was specified.
-:An invalid window handle was specified.
 ==Example Code==
 This example shows how to get the title-bar window text.
@@ Line 23: / Line 22: @@
 #define INCL_WINWINDOWMGR
 #define INCL_DOSMEMMGR
-#include <OS2.H>
+#include <os2.h>
 HWND   hwndFrame;
@@ Line 38: / Line 37: @@
 WinQueryWindowText(hwndFrame, sizeof(szTitle), szTitle);
-</pre>
-Definition
-<pre>
-#define INCL_WINWINDOWMGR /* Or use INCL_WIN, INCL_PM, */
-#include <os2.h>
-HWND    hwnd;     /*  Window handle. */
-LONG    lRetLen;  /*  Length of the window text. */
-lRetLen = WinQueryWindowTextLength(hwnd);
 </pre>
@@ Line 60: / Line 46: @@
 * [[WinSetDlgItemShort]]
 * [[WinSetDlgItemText]]
-* [[WinSetWindowText ]]
+* [[WinSetWindowText]]
 ==Related Messages==
 * WM_QUERYWINDOWPARAMS
 [[Category:Win]]