Macros
#define	LB_ADDSTRING 0xF180
	Appends the specified string. More...

#define	LB_INSERTSTRING 0xF181
	Inserts an item to the list box. More...

#define	LB_DELETESTRING 0xF182
	Removes an item from the list box. More...

#define	LB_SELITEMRANGEEX 0xF183
	reserved. More...

#define	LB_RESETCONTENT 0xF184
	Removes the contents of a list box. More...

#define	LB_GETSEL 0xF187
	Gets the selected state for an specified item. More...

#define	LB_SETSEL 0xF185
	Selects an item in a multiple-selection list box. More...

#define	LB_GETCURSEL 0xF188
	Gets the index of the currently selected or highlighted item. More...

#define	LB_SETCURSEL 0xF186
	Selects an item. More...

#define	LB_GETTEXT 0xF189
	Retrieves the text of an item in list box. More...

#define	LB_GETTEXTLEN 0xF18A
	Gets the length of text of item specified in a list box. More...

#define	LB_GETCOUNT 0xF18B
	Gets the number of items in the list box. More...

#define	LB_SELECTSTRING 0xF18C
	reserved. More...

#define	LB_DIR 0xF18D
	reserved. More...

#define	LB_GETTOPINDEX 0xF18E
	Gets the index to the first visible item in the list box. More...

#define	LB_FINDSTRING 0xF18F
	Searchs a specified string. More...

#define	LB_GETSELCOUNT 0xF190
	Gets the number of selected items in a multiple-selection list box. More...

#define	LB_GETSELITEMS 0xF191
	Gets the numbers of selected items. More...

#define	LB_GETHORIZONTALEXTENT 0xF193
	reserved. More...

#define	LB_SETHORIZONTALEXTENT 0xF194
	reserved. More...

#define	LB_SETCOLUMNWIDTH 0xF195
	reserved. More...

#define	LB_ADDFILE 0xF196
	reserved. More...

#define	LB_SETTOPINDEX 0xF197
	Ensures that a particular item in it is visible. More...

#define	LB_GETITEMRECT 0xF198
	Retrieves the dimensions of the rectangle. More...

#define	LB_GETITEMDATA 0xF199
	Gets item data in a list box if the box has LBS_CHECKBOX and/or LBS_USEICON styles. More...

#define	LB_SETITEMDATA 0xF19A
	Sets item data in a list box if the box has LBS_CHECKBOX and/or LBS_USEICON styles. More...

#define	LB_SETCARETINDEX 0xF19E
	Sets the focus rectangle to the item at the specified index. More...

#define	LB_GETCARETINDEX 0xF19F
	Determines the index of the item that has the focus rectangle. More...

#define	LB_SETITEMHEIGHT 0xF1A0
	Sets the height of all items. More...

#define	LB_GETITEMHEIGHT 0xF1A1
	Gets the height in pixels of an item specified in the wParam parameter. More...

#define	LB_FINDSTRINGEXACT 0xF1A2
	Searchs for an item that exactly matches the characters specified. More...

#define	LB_SETLOCALE 0xF1A5
	reserved. More...

#define	LB_GETLOCALE 0xF1A6
	reserved. More...

#define	LB_SETCOUNT 0xF1A7
	reserved. More...

#define	LB_INITSTORAGE 0xF1A8
	reserved. More...

#define	LB_ITEMFROMPOINT 0xF1A9
	reserved. More...

#define	LB_SETTEXT 0xF1AA
	Sets text of the specified item. More...

#define	LB_GETCHECKMARK 0xF1AB
	Gets check mark status of an item. More...

#define	LB_SETCHECKMARK 0xF1AC
	Sets check mark status of an item. More...

#define	LB_GETITEMADDDATA 0xF1AD
	Gets the 32-bit data value associated with an item. More...

#define	LB_SETITEMADDDATA 0xF1AE
	Associates a 32-bit data value with an item. More...

#define	LB_SETSTRCMPFUNC 0xF1AF
	Sets the STRCMP function used to sort items. More...

#define	LB_SETITEMDISABLE 0xF1B0
	Sets the item disable. More...

#define	LB_GETITEMDISABLE 0xF1B1
	Get the item disable status. More...

#define	LB_SETITEMBOLD 0xF1B2
	Sets the item display use bold font. More...

#define	LB_MULTIADDITEM 0xF1B3
	Appends the multi strings. More...

Detailed Description

Macro Definition Documentation

#define LB_ADDFILE 0xF196

reserved.

Definition at line 645 of file listbox.h.

#define LB_ADDSTRING 0xF180

Appends the specified string.

An application sends an LB_ADDSTRING message to append an item specified in the lParam parameter to a list box.

For a text-only list box:

 LB_ADDSTRING
 const char* text;
 
 wParam = 0;
 lParam = (LPARAM)text;

Parameters

text	Pointer to the string of the item to be added.

For a list box with check box or icon (with LBS_CHECKBOX or LBS_USEICON styles):

 LB_ADDSTRING
 PLISTBOXITEMINFO plbii;
 
 wParam = 0;
 lParam = (LPARAM)plbii;

Parameters

plbii Pointer to the listbox item info to be added.

Returns: The index of the new item on success, else the one of the following error codes:

LB_ERRSPACE No memory can be allocated for new item.
LB_ERR Invalid passed arguments.

Definition at line 265 of file listbox.h.

#define LB_DELETESTRING 0xF182

Removes an item from the list box.

An application sends an LB_DELETESTRING message to a list box to remove from the list box.

 LB_DELETESTRING
 int del;
 
 wParam = (WPARAM)del;
 lParam = 0;

Parameters

del	The index of the listbox item to be deleted.

Returns: LB_OKAY on success, else LB_ERR to indicate you passed an invalid index.

Definition at line 331 of file listbox.h.

#define LB_DIR 0xF18D

reserved.

Definition at line 528 of file listbox.h.

#define LB_FINDSTRING 0xF18F

Searchs a specified string.

An application sends an LB_FINDSTRING message to search a list box for an item that begins with the characters specified in the lParam parameter. The wParam parameter specifies the zero-based index of the item before the first item to be searched; The lParam parameter specifies a pointer to a null-terminated string that contains the prefix to search for.

 LB_FINDSTRING
 int index;
 char *string;
 
 wParam = (WPARAM)index;
 lParam = (LPARAM)string;

Parameters

index	The index of the item to be searched.
string	The string of the item to be searched.

Returns: The index of the matched item; LB_ERR for not found.

Definition at line 573 of file listbox.h.

#define LB_FINDSTRINGEXACT 0xF1A2

Searchs for an item that exactly matches the characters specified.

An application sends an LB_FINDSTRINGEXACT message to a list box to search it for an item that exactly matches the characters specified in the lParam parameter.

 LB_FINDSTRINGEXACT
 int index;
 const char *string;
 
 wParam = (WPARAM)index;
 lParam = (LPARAM)string;

Parameters

index	The index of the specified item.
string	The string of the item to be searched for.

Returns: The index of the found item on success, else LB_ERR.

Definition at line 853 of file listbox.h.

#define LB_GETCARETINDEX 0xF19F

Determines the index of the item that has the focus rectangle.

An application sends an LB_GETCARETINDEX message to a list box to determine the index of the item that has the focus rectangle in a multiple-selection list box.

 LB_GETCARETINDEX
 
 wParam = 0;
 lParam = 0;

Returns: The index of the item that has the focus rectangle.

Definition at line 791 of file listbox.h.

#define LB_GETCHECKMARK 0xF1AB

Gets check mark status of an item.

 LB_GETCHECKMARK
 int index;
 
 wParam = (WPARAM)index;
 lParam = 0;

Parameters

index The index of the specified item.

Returns: The check mark status of specified item on success; LB_ERR on error.

Return values

LB_ERR	Invalid item index or the list box have no LBS_CHECKBOX style.
CMFLAG_CHECKED	The item is checked.
CMFLAG_PARTCHECKED	The item is partly checked.
CMFLAG_BLANK	The item is not checked.

Definition at line 924 of file listbox.h.

#define LB_GETCOUNT 0xF18B

Gets the number of items in the list box.

An application sends an LB_GETCOUNT message to a list box to get the number of items in the list box.

 LB_GETCOUNT
 
 wParam = 0;
 lParam = 0;

Returns: The number of items in the listbox.

Definition at line 516 of file listbox.h.

#define LB_GETCURSEL 0xF188

Gets the index of the currently selected or highlighted item.

An application sends an LB_GETCURSEL message to a list box to get the index of the currently selected item, if there is one, in a single-selection list box. For multiple-selection list box, appliction send an LB_GETCURSEL message to a list box to get the index of the current highlighted item.

 LB_GETCURSEL
 
 wParam = 0;
 lParam = 0;

Returns: The index of the currently selected item for single-selection list box; Else the index of the highlighted item for multiple-selection list box.

Definition at line 427 of file listbox.h.

#define LB_GETHORIZONTALEXTENT 0xF193

reserved.

Definition at line 627 of file listbox.h.

#define LB_GETITEMADDDATA 0xF1AD

Gets the 32-bit data value associated with an item.

An application sends an LB_GETITEMADDDATA message to a list box to get the 32-bit data value the list box has stored for the item with index of wParam; By default this is zero. An application must set the item data value by sending an LB_SETITEMADDDATA message to the list box for this value to have meaning.

 LB_GETITEMADDDATA
 int index;
 
 wParam = (WPARAM)index;
 lParam = 0;

Parameters

index The index of the specified item.

Returns: The 32-bit data value associated with an item on success, otherwise LB_ERR to indicate an error.

Definition at line 974 of file listbox.h.

#define LB_GETITEMDATA 0xF199

Gets item data in a list box if the box has LBS_CHECKBOX and/or LBS_USEICON styles.

An application sends LB_GETITEMDATA message to a list box to retrive the check box flag and the handle of icon. Note that the text of the item will not be returned, i.e., the field of string of LISTBOXITEMINFO structure will be ignored.

 LB_GETITEMDATA
 int index;
 PLISTBOXITEMINFO plbii;
 
 wParam = (WPARAM)index;
 lParam = (LPARAM)plbii;

Parameters

index	The index of the specified item.
plbii	Pointer to the buffer used for storing the item data of the specified item.

Returns: LB_OKAY on success; LB_ERR on error.

See also: LISTBOXITEMINFO

Definition at line 722 of file listbox.h.

#define LB_GETITEMDISABLE 0xF1B1

Get the item disable status.

An application sends an LB_SETITEMDISABLE message to get a item to disable status.

1 wParam = index;

2 lParam = 0;

Returns

One of the following values:

TRUE
Item is disable
FLASE
Item is enable

Definition at line 1066 of file listbox.h.

#define LB_GETITEMHEIGHT 0xF1A1

Gets the height in pixels of an item specified in the wParam parameter.

An application sends an LB_GETITEMHEIGHT message to a list box to get the height in pixels of an item specified in the wParam parameter.

 LB_GETITEMHEIGHT
 
 wParam = 0;
 lParam = 0;

Returns: The height of item in the listbox.

Definition at line 830 of file listbox.h.

#define LB_GETITEMRECT 0xF198

Retrieves the dimensions of the rectangle.

An application sends an LB_GETITEMRECT message to a list box to retrieve the dimensions of the rectangle that bounds an item as it is currently displayed in the list box window. The item is specified in the wParam parameter, and a pointer to a RECT structure is given in the lParam parameter.

 LB_GETITEMRECT
 int index;
 RECT *rcItem;
 
 wParam = (WPARAM)index;
 lParam = (LPARAM)rcItem;

Parameters

index	The index of the specified item.
rcItem	Pointer to the buffer used for storing the item rect;

Returns: LB_OKAY on success; LB_ERR on error.

Definition at line 693 of file listbox.h.

#define LB_GETLOCALE 0xF1A6

reserved.

Definition at line 864 of file listbox.h.

#define LB_GETSEL 0xF187

Gets the selected state for an specified item.

An application sends an LB_GETSEL message to a list box to get the selected state for an item specified in the wParam parameter.

 LB_GETSEL
 int index;
 
 wParam = (WPARAM)index;
 lParam = 0;

Parameters

index The index of the specified item.

Returns

The state of the specified item:

0
Not selected.
>0
Selected.
LB_ERR
Invalid index.

Definition at line 379 of file listbox.h.

#define LB_GETSELCOUNT 0xF190

Gets the number of selected items in a multiple-selection list box.

An application sends an LB_GETSELCOUNT message to a list box to get the number of selected items in a multiple-selection list box.

 LB_GETSELCOUNT
 
 wParam = 0;
 lParam = 0;

Returns: The number of selected items in the multiple-selection listbox.

Definition at line 591 of file listbox.h.

#define LB_GETSELITEMS 0xF191

Gets the numbers of selected items.

An application sends an LB_GETSELITEMS message to a list box to fill a buffer with an array of integers that specify the item numbers of selected items in a multiple-selection list box.

 LB_GETSELITEMS
 int nItem;
 int *pInt;
 
 wParam = (WPARAM)nItem;
 lParam = (LPARAM)pInt;

Parameters

nItem	The maximum integer numbers wanted.
pInt	The buffer of an array of integers to save the indices of selected items.

Returns: The number of selected items.

Definition at line 615 of file listbox.h.

#define LB_GETTEXT 0xF189

Retrieves the text of an item in list box.

An application sends an LB_GETTEXT message to a list box to retrieve the text of an item.

 LB_GETTEXT
 int index;
 char *string;
 
 wParam = (WPARAM)index;
 lParam = (LPARAM)string;

Parameters

index	The index of the selected item.
string	Pointer to the string buffer. The buffer should be large enough to contain the text of the item.

Returns

One of the following values:

LB_OKAY
Success.
LB_ERR
Invalid item index.

See also: LB_GETTEXTLEN

Definition at line 477 of file listbox.h.

#define LB_GETTEXTLEN 0xF18A

Gets the length of text of item specified in a list box.

An application sends an LB_GETTEXTLEN message to a list box to get the length of text of the item specified in the wParam parameter.

 LB_GETTEXTLEN
 int index;
 
 wParam = (WPARAM)index;
 lParam = 0;

Parameters

index The index of the specified item.

Returns: The length of the strings on success, else LB_ERR to indicate invalid index.

Definition at line 498 of file listbox.h.

#define LB_GETTOPINDEX 0xF18E

Gets the index to the first visible item in the list box.

An application sends an LB_GETTOPINDEX message to get the index to the first visible item in the list box. Initially, the first visible item is item 0, but this changes as the list box is scrolled.

 LB_GETTOPINDEX
 
 wParam = 0;
 lParam = 0;

Returns: The index of the first visible item in the listbox.

Definition at line 547 of file listbox.h.

#define LB_INITSTORAGE 0xF1A8

reserved.

Definition at line 874 of file listbox.h.

#define LB_INSERTSTRING 0xF181

Inserts an item to the list box.

An application sends an LB_INSERTSTRING message to insert an item into a list box. Unlike LB_ADDSTRING message, the LB_INSERTSTRING message do not cause the list to be sorted.

For a text-only list box:

 LB_INSERTSTRING
 const char* text;
 
 wParam = index;
 lParam = (LPARAM)text;

Parameters

index	Specifies the index of the position at which to insert the item.
text	Pointer to the string of the item to be inserted.

For a list box with check box or icon (with LBS_CHECKBOX or LBS_USEICON styles):

 LB_INSERTSTRING
 int index;
 PLISTBOXITEMINFO plbii;
 
 wParam = (WPARAM)index;
 lParam = (LPARAM)plbii;

Parameters

index	Specifies the index of the position at which to insert the item.
plbii	Pointer to the listbox item info to be inserted.

Returns: The index of the new item on success, else the one of the following error codes:

LB_ERRSPACE No memory can be allocated for new item.
LB_ERR Invalid passed arguments.

Definition at line 310 of file listbox.h.

#define LB_ITEMFROMPOINT 0xF1A9

reserved.

Definition at line 879 of file listbox.h.

#define LB_MULTIADDITEM 0xF1B3

Appends the multi strings.

An application sends an LB_MULTIADDITEM message to append item array specified in the lParam parameter to a list box.

For a text-only list box:

 LB_MULTIADDITEM
 int num;
 const char text[num][];
 
 wParam = num;
 lParam = (LPARAM)text;

Parameters

num	is count of text array
text	pointer to the string of the item array to be added.

For a list box with check box or icon (with LBS_CHECKBOX or LBS_USEICON styles):

 LB_MULTIADDITEM
 LISTBOXITEMINFO plbii[num];
 
 wParam = num;
 lParam = (LPARAM)plbii;

Parameters

num	is count of plbii array
plbii	pointer to the listbox item info to be added.

Returns: The index of the new item on success, else the one of the following error codes:

LB_ERRSPACE No memory can be allocated for new item.
LB_ERR Invalid passed arguments.

Definition at line 1128 of file listbox.h.

#define LB_RESETCONTENT 0xF184

Removes the contents of a list box.

An application sends an LB_RESETCONTENT message to remove the all items in a list box.

 LB_RESETCONTENT
 
 wParam = 0;
 lParam = 0;

Returns: Always be zero.

Definition at line 355 of file listbox.h.

#define LB_SELECTSTRING 0xF18C

reserved.

Definition at line 522 of file listbox.h.

#define LB_SELITEMRANGEEX 0xF183

reserved.

#define LB_SETCARETINDEX 0xF19E

Sets the focus rectangle to the item at the specified index.

An application sends an LB_SETCARETINDEX message to set the focus rectangle to the item at the specified index in a multiple-selection list box.

 LB_SETCARETINDEX
 int index;
 
 wParam = (WPARAM)index;
 lParam = 0;

Definition at line 772 of file listbox.h.

#define LB_SETCHECKMARK 0xF1AC

Sets check mark status of an item.

 LB_SETCHECKMARK
 int index, status;
 
 wParam = (WPARAM)index;
 lParam = (LPARAM)status;

Parameters

index	The index of the specified item.
status	The new check mark status, can be one of the followings. CMFLAG_CHECKED The item is checked. CMFLAG_PARTCHECKED The item is partly checked.

Returns

One of the following values:

LB_OKAY
Success
LB_ERR
Invalid item index or this list box have no LBS_CHECKBOX style.

Definition at line 949 of file listbox.h.

#define LB_SETCOLUMNWIDTH 0xF195

reserved.

Definition at line 639 of file listbox.h.

#define LB_SETCOUNT 0xF1A7

reserved.

Definition at line 869 of file listbox.h.

#define LB_SETCURSEL 0xF186

Selects an item.

An application sends an LB_SETCURSEL message to a list box to select an item and scroll it into view, if necessary.

 LB_SETCURSEL
 int cursel;
 
 wParam = (WPARAM)cursel;
 lParam = 0;

Parameters

cursel The index of the item to be selected and hilighted.

Returns: The old index of the item selected on error, else LB_ERR to indicate an error occurred.

Definition at line 449 of file listbox.h.

#define LB_SETHORIZONTALEXTENT 0xF194

reserved.

Definition at line 633 of file listbox.h.

#define LB_SETITEMADDDATA 0xF1AE

Associates a 32-bit data value with an item.

An application sends an LB_SETITEMADDDATA message to associate a 32-bit data value specified in the lParam parameter with an item in the list box.

 LB_SETITEMADDDATA
 int index;
 DWORD addData;
 
 wParam = (WPARAM)index;
 lParam = (LPARAM)addData;

Parameters

index	The index of the specified item.
addData	the 32-bit data value which will associated with the item.

Returns

One of the following values:

LB_OKAY
Success
LB_ERR
Invalid item index

Definition at line 999 of file listbox.h.

#define LB_SETITEMBOLD 0xF1B2

Sets the item display use bold font.

An application sends an LB_SETITEMBOLD message to set a item display use bold font.

1 wParam = index;

2 lParam = (LPARAM)bold;

Returns

One of the following values:

LB_OKAY
Success
LB_ERR
index of item is not exist.

Definition at line 1084 of file listbox.h.

#define LB_SETITEMDATA 0xF19A

Sets item data in a list box if the box has LBS_CHECKBOX and/or LBS_USEICON styles.

An application sends LB_SETITEMDATA message to a list box to set the check box flag and the handle of icon. Note that the text of the item will not be changed, i.e., the field of string of LISTBOXITEMINFO structure will be ignored.

 LB_SETITEMDATA
 int index;
 PLISTBOXITEMINFO plbii;
 
 wParam = (WPARAM)index;
 lParam = (LPARAM)plbii;

Parameters

index	The index of the specified item.
plbii	Pointer to the buffer used for setting the item info of the specified item.

Returns: LB_OKAY on success; LB_ERR on error.

See also: LISTBOXITEMINFO

Definition at line 751 of file listbox.h.

#define LB_SETITEMDISABLE 0xF1B0

Sets the item disable.

An application sends an LB_SETITEMDISABLE message to set a item to disable.

1 wParam = index;

2 lParam = (LPARAM)disable;

Returns

One of the following values:

LB_OKAY
Success
LB_ERR
index of item is not exist.

Definition at line 1048 of file listbox.h.

#define LB_SETITEMHEIGHT 0xF1A0

Sets the height of all items.

An application sends an LB_SETITEMHEIGHT message to set the height of all items in a list box.

 LB_SETITEMHEIGHT
 int itemHeight;
 
 wParam = 0;
 lParam = (LPARAM)itemHeight;

Parameters

itemHeight New height of item.

Returns: The effective height of item.

Definition at line 812 of file listbox.h.

#define LB_SETLOCALE 0xF1A5

reserved.

Definition at line 859 of file listbox.h.

#define LB_SETSEL 0xF185

Selects an item in a multiple-selection list box.

An application sends an LB_SETSEL message to select an item in a multiple-selection list box and scroll it into view if necessary.

 LB_SETSEL
 int index, sel
 
 wParam = (WPARAM)sel;
 lParam = (LPARAM)index;

Parameters

sel	Indicates the changes to be made to the listbox item, can be one of the following values: -1 If the item has been selected, makes it unselected, vice versa. 0 Makes the item unselected. other Makes the item selected.
index	The index of the item.

Returns: LB_OKAY on success, else LB_ERR to indicate you passed an invalid index or the list box has no LBS_MULTIPLESEL style.

Definition at line 406 of file listbox.h.

#define LB_SETSTRCMPFUNC 0xF1AF

Sets the STRCMP function used to sort items.

An application sends an LB_SETSTRCMPFUNC message to set a new STRCMP function to sort items.

Note that you should send this message before adding any item to the list box control.

 static int my_strcmp (const char* s1, const char* s2, size_t n)
 {
      ...
      return 0;
 }
 
 LB_SETSTRCMPFUNC
 
 wParam = 0;
 lParam = (LPARAM)my_strcmp;

Parameters

my_strcmp Your own function to compare two strings.

Returns

One of the following values:

LB_OKAY
Success
LB_ERR
Not an empty list box.

Definition at line 1030 of file listbox.h.

#define LB_SETTEXT 0xF1AA

Sets text of the specified item.

 LB_SETTEXT
 int index;
 const char *string;
 
 wParam = (WPARAM)index;
 lParam = (LPARAM)string;

Parameters

index	The index of the specified item.
string	The string of the item to be set.

Returns

One of the following values:

LB_OKAY
Success
LB_ERR
Invalid item index or memory allocation error.

Definition at line 901 of file listbox.h.

#define LB_SETTOPINDEX 0xF197

Ensures that a particular item in it is visible.

An application sends an LB_SETTOPINDEX message to a list box to ensure that a particular item in it is visible. The item is specified in the wParam parameter. The list box scrolls so that either the specified item appears at the top of the list box or the maximum scroll range has been reached.

 LB_SETTOPINDEX
 int index;
 
 wParam = (WPARAM)index;
 lParam = 0;

Parameters

index The index of the particular item to be set.

Returns: Always be zero.

Definition at line 668 of file listbox.h.

Macros

Detailed Description

Macro Definition Documentation