CObList::RemoveHead

Syntax

CObject* RemoveHead();

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 library asserts. Use IsEmpty to verify that the list contains elements.

Return Value

The CObject pointer previously at the head of the list.

Example

CObList list;

CAge* pa1;

CAge* pa2;

list.AddHead( pa1 = new CAge( 21 ) );

list.AddHead( pa2 = new CAge( 40 ) ); // List now contains (40, 21)

ASSERT( *(CAge*) list.RemoveHead() == CAge( 40 ) ); // Old head

ASSERT( *(CAge*) list.GetHead() == CAge( 21 ) ); // New head

delete pa1;

delete pa2;