CStringArray Class
The new home for Visual Studio documentation is Visual Studio 2017 Documentation on docs.microsoft.com.
The latest version of this topic can be found at CStringArray Class.
Supports arrays of CString objects.
Syntax
class CStringArray : public CObject
Members
The member functions of CStringArray are similar to the member functions of class CObArray. 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 object (not a CString pointer). Wherever you see a CObject pointer as a function parameter, substitute a LPCTSTR.
CObject* CObArray::GetAt( int <nIndex> ) const;
for example, translates to
CString CStringArray::GetAt( int <nIndex> ) const;
and
void SetAt( int <nIndex>, CObject* <newElement> )
translates to
void SetAt( int <nIndex>, LPCTSTR <newElement> )
Public Constructors
| Name | Description |
|---|---|
| CObArray::CObArray | Constructs an empty array. |
Public Methods
| Name | Description |
|---|---|
| CObArray::Add | Adds an element to the end of the array; grows the array if necessary. |
| CObArray::Append | Appends another array to the array; grows the array if necessary. |
| CObArray::Copy | Copies another array to the array; grows the array if necessary. |
| CObArray::ElementAt | Returns a temporary reference to the element pointer within the array. |
| CObArray::FreeExtra | Frees all unused memory above the current upper bound. |
| CObArray::GetAt | Returns the value at a given index. |
| CObArray::GetCount | Gets the number of elements in this array. |
| CObArray::GetData | Allows access to elements in the array. Can be NULL. |
| CObArray::GetSize | Gets the number of elements in this array. |
| CObArray::GetUpperBound | Returns the largest valid index. |
| CObArray::InsertAt | Inserts an element (or all the elements in another array) at a specified index. |
| CObArray::IsEmpty | Determines if the array is empty. |
| CObArray::RemoveAll | Removes all the elements from this array. |
| CObArray::RemoveAt | Removes an element at a specific index. |
| CObArray::SetAt | Sets the value for a given index; array not allowed to grow. |
| CObArray::SetAtGrow | Sets the value for a given index; grows the array if necessary. |
| CObArray::SetSize | Sets the number of elements to be contained in this array. |
Public Operators
| Name | Description |
|---|---|
| CObArray::operator [ ] | Sets or gets the element at the specified index. |
Remarks
CStringArray incorporates the IMPLEMENT_SERIAL macro to support serialization and dumping of its elements. If an array of CString objects is stored to an archive, either with an overloaded insertion operator or with the Serialize member function, each element is serialized in turn.
Note
Before using an array, use SetSize to establish its size and allocate memory for it. If you do not use SetSize, adding elements to your array causes it to be frequently reallocated and copied. Frequent reallocation and copying are inefficient and can fragment memory.
If you need a dump of individual string elements in the array, you must set the depth of the dump context to 1 or greater.
When a CString array is deleted, or when its elements are removed, string memory is freed as appropriate.
For more information on using CStringArray, see the article Collections.
Inheritance Hierarchy
CStringArray
Requirements
Header: afxcoll.h