Register a list item defined by the parameters of the function in the list resource.

Syntax

bool AL_AddListItemEx(
  LIST_HANDLE list,
  const char *listText,
  int paletteIndex,
  int showControl,
  bool checked,
  int userParam1,
  int userParam2,
  char *userParam3
);

Parameters

list
[in] List handle
listText
[in] Display string:
Specifies the string to display in the list item.
paletteIndex
[in] Palette index:
Specify the display color of the list item with the palette index. Specify 0 if you have not registered your own color palette.
showControl
[in] Type of control:
Specify the type of control to add to this list item with one of the following values.
ValueDescription
AM_NO_CONTROLNo control is added.
AM_CHECK_BOXDisplays a check box in front of the display string.
AM_RADIO_BTNDisplays a radio button in front of the display string.
checked
[in] checked attribute:
When the value of showControl is AM_CHECK_BOX or AM_RADIO_BTN, specifies the state of the radio button or check box. If true, the checked state is displayed, otherwise the unchecked state is displayed.
userParam1
[in] int parameter for application program.
userParam2
[in] int parameter for application program.
userParam3
[in] A pointer to 16 bytes char array parameter for application program.

Return value

Returns true if the function succeeds, false otherwise.

Remarks

Register a list item defined by the parameters of this function in the list resource of the list handle specified by list. The string specified by listText is duplicated in the list resource

List items registered in the list resource are referenced by specifying an index namber starting from 0.

Please note that the list display is not updated just by adding a list item with this function.

Requirements

Header file:
lib.h
AdvancedMenu.h
Library file:
libAdvancedMenu.a
libSTARTUPOPH5000.a

See also

Last updated: 2020/10/13