Share via


CListBox::SetTopIndex

Ensures that a particular list-box item is visible.

int SetTopIndex(
   int nIndex 
);

Parameters

  • nIndex
    Specifies the zero-based index of the list-box item.

Return Value

Zero if successful, or LB_ERR if an error occurs.

Remarks

The system scrolls the list box until either the item specified by nIndex appears at the top of the list box or the maximum scroll range has been reached.

Example

// Set the first visible item in the list box to be the middle item
m_myListBox.SetTopIndex(m_myListBox.GetCount()/2);

Requirements

Header: afxwin.h

See Also

Reference

CListBox Class

Hierarchy Chart

CListBox::GetTopIndex

LB_SETTOPINDEX

Other Resources

CListBox Members