CStringList Class¶

Overview
Quick Reference
Constructors
Methods

Overview¶

Note

The CStringList class handles string lists

The structure used for this class is CStringList

Quick Reference¶

Quick Ref

void CStringList::CStringList(int nBlockSize)

virtual void CStringList::~CStringList()

POSITION* CStringList::AddHead(CString& newElement)

POSITION* CStringList::AddHead(const char* newElement)

POSITION* CStringList::AddTail(CString& newElement)

POSITION* CStringList::AddTail(const char* newElement)

void CStringList::AddTail(CStringList* pNewList)

POSITION* CStringList::FindIndex(int nIndex)

POSITION* CStringList::InsertBefore(POSITION* position, CString& newElement)

CStringList::CNode* CStringList::NewNode(CStringList::CNode* pPrev, CStringList::CNode* pNext)

void CStringList::RemoveAll()

void CStringList::RemoveAt(POSITION* position)

Constructors¶

Name	Description
CStringList::CStringList	Constructs a `CStringList` object
CStringList::CStringList	Destroys a `CStringList` object

CStringList::CStringList¶

Constructs a CStringList object

void CStringList::CStringList();

Parameters

int nBlockSize - the memory-allocation granularity for extending the list

Remarks

Constructs a CStringList object

As the list grows, memory is allocated in units of nBlockSize entries

CStringList::~CStringList¶

Destroys the CStringList object

virtual void CStringList::~CStringList();

Remarks

Destroys the CStringList object

Methods¶

Name	Description
CStringList::AddHead	Adds a new element or list of elements to the head of this list
CStringList::AddTail	Adds a new element or list of elements to the tail of this list
CStringList::FindIndex	Uses the value of nIndex as an index into the list
CStringList::InsertBefore	Adds an element to this list before the element at the specified position
CStringList::NewNode	Adds a new node to a list
CStringList::RemoveAll	Removes all the elements from this list and frees the associated list memory
CStringList::RemoveAt	Removes the specified element from this list

CStringList::AddHead¶

Adds an element (or all the elements in another list) to the head of the list (makes a new head)

POSITION* CStringList::AddHead(CString& newElement);

Parameters

CString& newElement - the element to be added to this list

Return Value

Returns POSITION*, the value of the newly inserted element

Remarks

The list can be empty before the operation

CStringList::AddHead¶

Adds an element (or all the elements in another list) to the head of the list (makes a new head)

POSITION* CStringList::AddHead(const char* newElement);

Parameters

const char* newElement - the element to be added to this list

Return Value

Returns POSITION*

Remarks

The list can be empty before the operation

CStringList::AddTail¶

Adds an element (or all the elements in another list) to the tail of the list (makes a new tail)

POSITION* CStringList::AddTail(CString& newElement);

Parameters

CString& newElement - the element to be added to this list

Return Value

Returns POSITION*

Remarks

The list can be empty before the operation

CStringList::AddTail¶

Adds an element (or all the elements in another list) to the tail of the list (makes a new tail)

POSITION* CStringList::AddTail(const char* newElement);

Parameters

const char* newElement - the element to be added to this list

Return Value

Returns POSITION*

Remarks

The list can be empty before the operation

CStringList::AddTail¶

Adds an element (or all the elements in another list) to the tail of the list (makes a new tail)

void CStringList::AddTail(CStringList* pNewList);

Parameters

CStringList* pNewList - the list to be added to this list

Remarks

The list can be empty before the operation

CStringList::FindIndex¶

Uses the value of nIndex as an index into the list

POSITION* CStringList::FindIndex(int nIndex);

Parameters

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

Return Value

Returns POSITION*

Remarks

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

CStringList::InsertBefore¶

Adds an element to this list before the element at the specified position

POSITION* CStringList::InsertBefore(
   POSITION* position,
   CString& newElement);

Parameters

POSITION* position - a POSITION value returned by a previous Find member function call.
CString& newElement - the element to be added to this list

Return Value

Returns POSITION*

Remarks

A POSITION value that can be used for iteration or object pointer retrieval

Returns NULL if the list is empty

CStringList::NewNode¶

Adds a new node to a list

CStringList::CNode* CStringList::NewNode(
   CStringList::CNode* pPrev,
   CStringList::CNode* pNext);

Parameters

CStringList::CNode* pPrev - pointer to previous node
CStringList::CNode* pNext - pointer to next node

Return Value

Returns CStringList::CNode*

Remarks

CStringList::RemoveAll¶

Removes all the elements from this list and frees the associated list memory

void CStringList::RemoveAll();

Remarks

CStringList::RemoveAt¶

Removes the specified element from this list

void CStringList::RemoveAt(POSITION* position);

Parameters

POSITION* position - the position of the element to be removed from the list

Remarks

When you remove an element from a CStringList, you remove the object pointer from the list. It is your responsibility to delete the objects themselves.