Edit

COMBOBOXEXITEMA structure (commctrl.h)

  • Article

Contains information about an item in a ComboBoxEx control.

Syntax

typedef struct tagCOMBOBOXEXITEMA {
  UINT    mask;
  INT_PTR iItem;
  LPSTR   pszText;
  int     cchTextMax;
  int     iImage;
  int     iSelectedImage;
  int     iOverlay;
  int     iIndent;
  LPARAM  lParam;
} COMBOBOXEXITEMA, *PCOMBOBOXEXITEMA;

Members

mask

Type: UINT

A set of bit flags that specify attributes of this structure or of an operation that is using this structure. The flags specify members that are valid or must be filled in. This member can be a combination of the following values.

Value Meaning
CBEIF_DI_SETITEM
 Set this flag when processing CBEN_GETDISPINFO; the ComboBoxEx control will retain the supplied information and will not request it again.
CBEIF_IMAGE
 The iImage member is valid or must be filled in.
CBEIF_INDENT
 The iIndent member is valid or must be filled in.
CBEIF_LPARAM
 The lParam member is valid or must be filled in.
CBEIF_OVERLAY
 The iOverlay member is valid or must be filled in.
CBEIF_SELECTEDIMAGE
 The iSelectedImage member is valid or must be filled in.
CBEIF_TEXT
 The pszText member is valid or must be filled in.

iItem

Type: INT_PTR

The zero-based index of the item.

pszText

Type: LPTSTR

A pointer to a character buffer that contains or receives the item's text. If text information is being retrieved, this member must be set to the address of a character buffer that will receive the text. The size of this buffer must also be indicated in cchTextMax. If this member is set to LPSTR_TEXTCALLBACK, the control will request the information by using the CBEN_GETDISPINFO notification codes.

cchTextMax

Type: int

The length of pszText, in TCHARs. If text information is being set, this member is ignored.

iImage

Type: int

The zero-based index of an image within the image list. The specified image will be displayed for the item when it is not selected. If this member is set to I_IMAGECALLBACK, the control will request the information by using CBEN_GETDISPINFO notification codes.

iSelectedImage

Type: int

The zero-based index of an image within the image list. The specified image will be displayed for the item when it is selected. If this member is set to I_IMAGECALLBACK, the control will request the information by using CBEN_GETDISPINFO notification codes.

iOverlay

Type: int

The one-based index of an overlay image within the image list. If this member is set to I_IMAGECALLBACK, the control will request the information by using CBEN_GETDISPINFO notification codes.

iIndent

Type: int

The number of indent spaces to display for the item. Each indentation equals 10 pixels. If this member is set to I_INDENTCALLBACK, the control will request the information by using CBEN_GETDISPINFO notification codes.

lParam

Type: LPARAM

A value specific to the item.

Remarks

Note

The commctrl.h header defines COMBOBOXEXITEM as an alias which automatically selects the ANSI or Unicode version of this function based on the definition of the UNICODE preprocessor constant. Mixing usage of the encoding-neutral alias with code that not encoding-neutral can lead to mismatches that result in compilation or runtime errors. For more information, see Conventions for Function Prototypes.

Requirements

Requirement Value
Minimum supported client Windows Vista [desktop apps only]
Minimum supported server Windows Server 2003 [desktop apps only]
Header commctrl.h