Important:
This is retired content. This content is outdated and is no longer being maintained. It is provided as a courtesy for individuals who are still using these technologies. This content may contain URLs that were valid when originally published, but now link to sites or pages that no longer exist.
A version of this page is also available for
4/8/2010

The following table shows the list-view controls macros, with a description of the purpose of each.

Programming element Description

ListView_ApproximateViewRect

This macro calculates the approximate width and height required to display a specified number of items.

ListView_Arrange

This macro arranges items in icon view.

ListView_CreateDragImage

This macro creates a drag image list for the specified item.

ListView_DeleteAllItems

This macro removes all items from a list-view control.

ListView_DeleteColumn

This macro removes a column from a list-view control.

ListView_DeleteItem

This macro removes an item from a list-view control.

ListView_EditLabel

This macro begins in-place editing of the specified list-view item's text.

ListView_EnableGroupView

This macro determines whether the items in a list-view control display as a group.

ListView_EnsureVisible

This macro ensures that a list-view item is either entirely or partially visible, scrolling the list-view control if necessary.

ListView_FindItem

This macro searches for a list-view item with the specified characteristics.

ListView_GetBkColor

This macro retrieves the background color of a list-view control.

ListView_GetBkImage

This macro retrieves the background image in a list-view control.

ListView_GetCallbackMask

This macro retrieves the callback mask for a list-view control.

ListView_GetCheckState

This macro determines if an item in a list-view control is selected.

ListView_GetColumn

This macro retrieves the attributes of a list-view control's column.

ListView_GetColumnOrderArray

This macro retrieves the current left-to-right order of columns in a list-view control.

ListView_GetColumnWidth

This macro retrieves the width of a column in report or list view.

ListView_GetCountPerPage

This macro calculates the number of items that can fit vertically in the visible area of a list-view control when in list or report view.

ListView_GetEditControl

This macro retrieves the handle to the edit control being used to edit a list-view item's text.

ListView_GetExtendedListViewStyle

This macro retrieves the extended styles that are currently in use for a specified list-view control.

ListView_GetGroupCount

This macro gets the number of available groups for the list-view control.

ListView_GetGroupInfo

This macro retrieves group information.

ListView_GetGroupInfoByIndex

This macro gets the list-view group's information. This information is based on the group index.

ListView_GetGroupMetrics

This macro retrieves the metrics of a group.

ListView_GetHeader

This macro retrieves the handle to the header control used by a list-view control.

ListView_GetImageList

This macro retrieves the handle to an image list used for drawing list-view items.

ListView_GetISearchString

This macro retrieves the incremental search string of a list-view control.

ListView_GetItem

This macro retrieves some or all of a list-view item's attributes.

ListView_GetItemCount

This macro retrieves the number of items in a list-view control.

ListView_GetItemPosition

This macro retrieves the position of a list-view item.

ListView_GetItemRect

This macro retrieves the bounding rectangle for all or part of an item in the current view.

ListView_GetItemSpacing

This macro determines the spacing between items in a list-view control.

ListView_GetItemState

This macro retrieves the state of a list-view item.

ListView_GetItemText

This macro retrieves the text of a list-view item or subitem.

ListView_GetNextItem

This inline function searches for a list-view item that has the specified properties and bears the specified relationship to a specified item.

ListView_GetNumberOfWorkAreas

This macro retrieves the number of working areas in a list-view control.

ListView_GetOrigin

This macro retrieves the current view origin for a list-view control.

ListView_GetSelectedCount

This macro determines the number of selected items in a list-view control.

ListView_GetSelectionMark

This macro retrieves the selection mark from a list-view control.

ListView_GetStringWidth

This macro determines the width of a specified string, using the specified list-view control's current font.

ListView_GetSubItemRect

This macro retrieves information about the rectangle that surrounds a subitem in a list-view control.

ListView_GetTextBkColor

This macro retrieves the text background color of a list-view control.

ListView_GetTextColor

This macro retrieves the text color of a list-view control.

ListView_GetTopIndex

This macro retrieves the index of the topmost visible item when in list or report view.

ListView_GetViewRect

This macro retrieves the bounding rectangle of all items in the list-view control.

ListView_GetWorkAreas

This macro retrieves the working areas from a list-view control.

ListView_HasGroup

This macro determines whether the list-view control has a specified group.

ListView_HitTest

This macro determines which list-view item, if any, is at a specified position.

ListView_InsertColumn

This macro inserts a new column in a list-view control.

ListView_InsertGroup

This macro inserts a group into a list-view control.

ListView_InsertGroupSorted

This macro inserts a group into an ordered list of groups.

ListView_InsertItem

This macro inserts a new item in a list-view control.

ListView_IsGroupViewEnabled

This macro checks whether the list-view control has group view enabled.

ListView_MapIDToIndex

This macro maps the identifier (ID) of an item to an index.

ListView_MapIndexToID

This macro maps the index of an item to a unique identifier (ID).

ListView_MoveGroup

This macro moves the group to the specified zero based index.

ListView_MoveItemToGroup

This macro moves an item specified by an index into a group.

ListView_RedrawItems

This macro forces a list-view control to redraw a range of items.

ListView_RemoveAllGroups

This macro removes all groups from a list-view control.

ListView_RemoveGroup

This macro removes a group from a list-view control.

ListView_Scroll

This macro scrolls the content of a list-view control.

ListView_SetBkColor

This macro sets the background color a list-view control.

ListView_SetBkImage

This macro sets the background image in a list-view control.

ListView_SetCallbackMask

This macro changes the callback mask for a list-view control.

ListView_SetColumn

This macro sets the attributes of a list-view column.

ListView_SetColumnOrderArray

This macro sets the left-to-right order of columns in a list-view control.

ListView_SetColumnWidth

This macro changes the width of a column in report or list view.

ListView_SetExtendedListViewStyle

This macro sets extended styles for list-view controls.

ListView_SetExtendedListViewStyleEx

This macro sets extended styles for list-view controls using the style mask.

ListView_SetGroupInfo

This macro sets group information.

ListView_SetGroupMetrics

This macro sets the metrics of a group.

ListView_SetIconSpacing

This macro sets the spacing between icons in list-view controls set to the LVS_ICON style.

ListView_SetImageList

This macro assigns an image list to a list-view control.

ListView_SetInfoTip

This macro sets the tooltip text.

ListView_SetItem

This macro sets some or all of a list-view item's attributes.

ListView_SetItemCount

This macro prepares a list-view control for adding a large number of items.

ListView_SetItemCountEx

This macro sets the virtual number of items in a virtual list-view control.

ListView_SetItemPosition

This macro moves an item to a specified position in a list-view control, which must be in icon or small icon view.

ListView_SetItemPosition32

This macro moves an item to a specified position in a list-view control, which must be in icon or small icon view.

ListView_SetItemState

This macro changes the state of an item in a list-view control.

ListView_SetItemText

This macro changes the text of a list-view item or subitem.

ListView_SetSelectionMark

This macro sets the selection mark in a list-view control.

ListView_SetTextBkColor

This macro sets the background color of text in a list-view control.

ListView_SetTextColor

This macro sets the text color of a list-view control.

ListView_SetToolTips

This macro sets the ToolTip control that the list-view control will use to display ToolTips.

ListView_SetWorkAreas

This macro sets the working area within a list-view control.

ListView_SortGroups

This macro uses an application-defined comparison function to sort groups by identifier (ID) within a list-view control.

ListView_SortItems

This macro uses an application-defined comparison function to sort the items of a list-view control.

ListView_SubItemHitTest

This macro determines which list-view item or subitem is located at a specified position.

ListView_Update

This macro updates a list-view item.

See Also