Export (0) Print
Expand All
Expand Minimize

CByteArray Class

Supports dynamic arrays of bytes.

class CByteArray : public CObject

The member functions of CByteArray 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 function parameter or return value, substitute a BYTE.

CObject* CObArray::GetAt( int <nIndex> ) const;

for example, translates to

BYTE CByteArray::GetAt( int <nIndex> ) const;

Name

Description

CObArray::CObArray

Constructs an empty array.

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 byte 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.

Name

Description

CObArray::operator [ ]

Sets or gets the element at the specified index.

CByteArray incorporates the IMPLEMENT_SERIAL macro to support serialization and dumping of its elements. If an array of bytes is stored to an archive, either with the overloaded insertion (<<) operator or with the Serialize member function, each element is, in turn, serialized.

Note 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 debug output from individual elements in the array, you must set the depth of the CDumpContext object to 1 or greater.

For more information on using CByteArray, see the article Collections.

Header: afxcoll.h

Show:
© 2014 Microsoft