The TB_GETBUTTONINFO message retrieves information for a button on a soft key bar. The information can include the ID, text, and state of the button, as well as the handle of the pop-up menu associated with the button.

Syntax

TB_GETBUTTONINFO
  wParam = (WPARAM) (int) iID;
  lParam = (LPARAM) (LPTBBUTTONINFO) lptbbi;

Parameters

iID

The command identifier of the button.

lptbbi

References a Windows CE TBBUTTONINFO structure that receives the button information.

Windows Mobile-based Smartphone supports retrieving the following information in the Windows CE TBBUTTONINFO structure:

• fsState
• idCommand
• lParam
• pszText

Return Values

Returns the zero-based index of the button or -1 if an error occurs.

Remarks

The cbSize and dwMask members of a Windows CE TBBUTTONINFO structure must be assigned values prior to sending the TB_GETBUTTONINFO message.

Requirements

Pocket PC: Pocket PC 2002 and later.
Smartphone: Smartphone 2002 and later.
OS Versions: Windows CE 3.0 and later.
Header: Aygshell.h.
Library: Aygshell.lib.

See Also

TBBUTTONINFO structure

Send Feedback on this topic to the authors

Feedback FAQs

© 2006 Microsoft Corporation. All rights reserved.