CObList::FindIndex

Article
12/01/2015

Uses the value of nIndex as an index into the list.

Syntax

      POSITION FindIndex(
   INT_PTR nIndex 
) const;

Parameters

nIndex
The zero-based index of the list element to be found.

Return Value

A POSITION value that can be used for iteration or object pointer retrieval; NULL if nIndex is too large. (The framework generates an assertion if nIndex is negative.)

Remarks

It starts a sequential scan from the head of the list, stopping on the nth element.

The following table shows other member functions that are similar to CObList::FindIndex.

Class	Member Function
CPtrList	POSITION FindIndex( INT_PTR nIndex ) const;
CStringList	POSITION FindIndex( INT_PTR nIndex ) const;

Example

See CObList::CObList for a listing of the CAge class.

CObList list;
POSITION pos;

list.AddHead(new CAge(21));
list.AddHead(new CAge(40)); // List now contains (40, 21).
if ((pos = list.FindIndex(0)) != NULL)
{
    ASSERT(*(CAge*) list.GetAt(pos) == CAge(40));
}

Requirements

Header: afxcoll.h