TB_GETSTRING message

Retrieves a string from a toolbar's string pool.

Parameters

wParam

The LOWORD specifies the length of the lParam buffer, in bytes. The HIWORD specifies the index of the string.

lParam

Pointer to a buffer used to return the string.

Return value

Returns the string length if successful, or -1 otherwise.

Remarks

This message returns the specified string from the toolbar's string pool. It does not necessarily correspond to the text string currently being displayed by a button. To retrieve a button's current text string, send the toolbar a TB_GETBUTTONTEXT message.

Requirements

Requirement Value
Minimum supported client
Windows Vista [desktop apps only]
Minimum supported server
Windows Server 2003 [desktop apps only]
Header
Commctrl.h
Unicode and ANSI names
TB_GETSTRINGW (Unicode) and TB_GETSTRINGA (ANSI)

See also

Reference

TB_ADDSTRING

TB_ADDBUTTONS

TB_INSERTBUTTON