Share via


Header_GetItem

This macro retrieves information about an item in a header control. You can use this macro or send the HDM_GETITEM message explicitly.

BOOL Header_GetItem( hwndHD, index, phdi );

Parameters

  • hwndHD
    Handle to the header control.
  • index
    Index of the item for which information is to be retrieved.
  • phdi
    Pointer to an HDITEM structure. When the message is sent, the mask member indicates the type of information being requested. When the message returns, the other members receive the requested information. If the mask member specifies zero, the message returns TRUE but copies no information to the structure.

Return Values

TRUE indicates success. FALSE indicates failure.

Remarks

The Header_GetItem macro is defined as follows:

#define Header_GetItem(hwndHD, index, phdi)\
(BOOL)SendMessage((hwndHD), HDM_GETITEM,\
(WPARAM)(int)(index), (LPARAM)(LPHDITEM)(phdi)) 

Requirements

Runs on Versions Defined in Include Link to
Windows CE OS 1.0 and later Commctrl.h   Commctrl.lib

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.

See Also

HDM_GETITEM HDITEM

 Last updated on Tuesday, July 13, 2004

© 1992-2000 Microsoft Corporation. All rights reserved.