CList::RemoveHead

TYPERemoveHead();

Return Value

The element previously at the head of the list.

Parameters

TYPE

Template parameter specifying the type of elements in the list.

Remarks

Removes the element from the head of the list and returns a pointer to it.

You must ensure that the list is not empty before calling RemoveHead. If the list is empty, then the Debug version of the Microsoft Foundation Class Library asserts. Use IsEmpty to verify that the list contains elements.

Example

// Define myList.
CList<CString,CString&> myList;

// Add two elements to the list.
myList.AddHead(CString("ABC"));
myList.AddHead(CString("123"));

// Remove the head element and verify the list.
// NOTE: once the head is removed, the number of
// elements in the list will be one.
CString strHead = myList.RemoveHead();
ASSERT((CString("123") == strHead) && (myList.GetCount() == 1) && (CString("ABC") == myList.GetHead()));

CList OverviewClass MembersHierarchy Chart

See Also   CList::GetHead, CList::AddHead