LB_GETTEXTLEN

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 message is sent by an application to retrieve the length of a string in a list box.

LB_GETTEXTLEN
wParam=
(WPARAM)
index
;
lParam= 0
;

Parameters

index

Zero-based index of the string.

Return Values

The length of the string, in characters and excluding the terminating null character, indicates success. Under certain conditions, this value may actually be greater than the length of the text. For more information, see the following Remarks section.

LB_ERR indicates that the indexparameter does not specify a valid index.

Remarks

Under certain conditions, the return value is larger than the actual length of the text. This occurs with certain mixtures of ANSI and Unicode, and is due to the operating system allowing for the possible existence of double-byte character set (DBCS) characters within the text. The return value, however, will always be at least as large as the actual length of the text; you can thus always use it to guide buffer allocation. This behavior can occur when an application uses both ANSI functions and common dialogs, which use Unicode.

To obtain the exact length of the text, use the WM_GETTEXT, LB_GETTEXT, or CB_GETLBTEXTmessages, or the GetWindowTextfunction.

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.