Skip to content

Latest commit

 

History

History
121 lines (80 loc) · 3.38 KB

celementtraitsbase-class.md

File metadata and controls

121 lines (80 loc) · 3.38 KB
Raw
description title ms.date f1_keywords helpviewer_keywords ms.assetid
Learn more about: CElementTraitsBase Class
CElementTraitsBase Class
11/04/2016
CElementTraitsBase
ATLCOLL/ATL::CElementTraitsBase
ATLCOLL/ATL::CElementTraitsBase::INARGTYPE
ATLCOLL/ATL::CElementTraitsBase::OUTARGTYPE
ATLCOLL/ATL::CElementTraitsBase::CopyElements
ATLCOLL/ATL::CElementTraitsBase::RelocateElements
CElementTraitsBase class
75284caf-347e-4355-a7d8-efc708dd514a

CElementTraitsBase Class

This class provides default copy and move methods for a collection class.

Syntax

template<typename T>
class CElementTraitsBase

Parameters

T
The type of data to be stored in the collection.

Members

Public Typedefs

Name Description
CElementTraitsBase::INARGTYPE The data type to use for adding elements to the collection class object.
CElementTraitsBase::OUTARGTYPE The data type to use for retrieving elements from the collection class object.

Public Methods

Name Description
CElementTraitsBase::CopyElements Call this method to copy elements stored in a collection class object.
CElementTraitsBase::RelocateElements Call this method to relocate elements stored in a collection class object.

Remarks

This base class defines methods for copying and relocating elements in a collection class. It is utilized by the classes CDefaultElementTraits, CStringRefElementTraits, and CStringElementTraitsI.

For more information, see ATL Collection Classes.

Requirements

Header: atlcoll.h

CElementTraitsBase::CopyElements

Call this method to copy elements stored in a collection class object.

static void CopyElements(
    T* pDest,
    const T* pSrc,
    size_t nElements);

Parameters

pDest
Pointer to the first element that will receive the copied data.

pSrc
Pointer to the first element to copy.

nElements
The number of elements to copy.

Remarks

The source and destination elements should not overlap.

CElementTraitsBase::INARGTYPE

The data type to use for adding elements to the collection.

typedef const T& INARGTYPE;

CElementTraitsBase::OUTARGTYPE

The data type to use for retrieving elements from the collection.

typedef T& OUTARGTYPE;

CElementTraitsBase::RelocateElements

Call this method to relocate elements stored in a collection class object.

static void RelocateElements(
    T* pDest,
    T* pSrc,
    size_t nElements);

Parameters

pDest
Pointer to the first element that will receive the relocated data.

pSrc
Pointer to the first element to relocate.

nElements
The number of elements to relocate.

Remarks

This method calls memmove, which is sufficient for most data types. If the objects being moved contain pointers to their own members, this method will need to be overridden.

See also

Class Overview