CListBox::InsertString

Inserts a string into the list box.

int InsertString(
   int nIndex,
   LPCTSTR lpszItem 
);

Parameters

  • nIndex
    Specifies the zero-based index of the position to insert the string. If this parameter is –1, the string is added to the end of the list.

  • lpszItem
    Points to the null-terminated string that is to be inserted.

Return Value

The zero-based index of the position at which the string was inserted. The return value is LB_ERR if an error occurs; the return value is LB_ERRSPACE if insufficient space is available to store the new string.

Remarks

Unlike the AddString member function, InsertString does not cause a list with the LBS_SORT style to be sorted.

Example

// Insert items in between existing items.
CString str;
int n = m_myListBox.GetCount();
for (int i = 0; i < n; i++)
{
   str.Format(_T("item string %c"), (char)('A' + i));
   m_myListBox.InsertString(2 * i, str);
}

Requirements

Header: afxwin.h

See Also

Concepts

CListBox Class

CListBox Members

Hierarchy Chart

CListBox::AddString

LB_INSERTSTRING