Important Notice

The pages on this site contain documentation for very old MS-DOS software, purely for historical purposes. If you're looking for up-to-date documentation, particularly for programming, you should not rely on the information found here, as it will be woefully out of date.

◄CObject►                                     ◄Up► ◄Contents► ◄Index► ◄Back►
──Microsoft Foundation Classes──────────────────────────────────────────────
 
  Description
 
  The CStringList class supports lists of CString objects. All comparisons
  are done "by value," meaning that the characters in the string are
  compared instead of the addresses of the strings.
 
  The member functions of CStringList are similar to the member functions
  of class ◄CObList► Because of this similarity, you can use the CObArray
  reference documentation for member function specifics. Wherever you see
  a CObject pointer as a return value, substitute a CString. Wherever you
  see a CObject pointer as a function parameter, substitute a const
  pointer to char.
 
  CObject*& CObList::GetHead() const;
 
  for example, translates to
 
  CString& CStringList::GetHead() const;
 
  and
 
  POSITION AddHead( CObject* <newElement> );
 
  translates to
 
  POSITION AddHead( const char* <newElement> );
 
  CStringList incorporates the IMPLEMENT_SERIAL macro to support
  serialization and dumping of its elements. If a list of CStrings is
  stored to an archive, either with the overloaded insertion operator or
  with the Serialize member function, each CString element is, in turn,
  serialized.
 
  If you need a dump of individual CString elements, you must set the
  depth of the dump context to 1 or greater.
 
  When a CStringList object is deleted, or when its elements are removed,
  the CString objects are deleted as appropriate.
 
  #include <afxcoll.h>
 
  Public Members
 
  Construction/Destruction
 
  ◄CStringList►   Constructs an empty list for CString objects.
 
  ◄~CStringList►   Destroys a CStringList object.
 
  Head/Tail Access
 
  ◄GetHead►   Returns the head element of the list (cannot be empty).
 
  ◄GetTail►   Returns the tail element of the list (cannot be empty).
 
  Operations
 
  ◄RemoveHead►   Removes the element from the head of the list.
 
  ◄RemoveTail►   Removes the element from the tail of the list.
 
  ◄AddHead►      Adds an element (or all the elements in another list) to
                 the head of the list (makes a new head).
 
  ◄AddTail►      Adds an element (or all the elements in another list) to
                 the tail of the list (makes a new tail).
 
  ◄RemoveAll►    Removes all the elements from this list.
 
  Iteration
 
  ◄GetHeadPosition►   Returns the position of the head element of the
                      list.
 
  ◄GetTailPosition►   Returns the position of the tail element of the
                      list.
 
  ◄GetNext►           Gets the next element for iterating.
 
  ◄GetPrev►           Gets the previous element for iterating.
 
  Retrieval/Modification
 
  ◄GetAt►      Gets the element at a given position.
 
  ◄SetAt►      Sets the element at a given position.
 
  ◄RemoveAt►   Removes an element from this list as specified by
               position.
 
  Insertion
 
  ◄InsertBefore►   Inserts a new element before a given position.
 
  ◄InsertAfter►    Inserts a new element after a given position.
 
  Searching
 
  ◄Find►        Gets the position of an element specified by string
                value.
 
  ◄FindIndex►   Gets the position of an element specified by a zero-based
                index.
 
  Status
 
  ◄GetCount►   Returns the number of elements in this list.
 
  ◄IsEmpty►    Tests for the empty list condition (no elements).
 
 
                                     -♦-