CHeapPtrElementTraits 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 CHeapPtrElementTraits Class.
This class provides methods, static functions, and typedefs useful when creating collections of heap pointers.
Important
This class and its members cannot be used in applications that execute in the Windows Runtime.
Syntax
template<typename T, class Allocator = ATL::CCRTAllocator>
class CHeapPtrElementTraits :
public CDefaultElementTraits<ATL::CHeapPtr<T, Allocator>>
Parameters
T
The object type to be stored in the collection class.
Allocator
The memory allocation class to use. The default is CCRTAllocator.
Members
Public Typedefs
Name | Description |
---|---|
CHeapPtrElementTraits::INARGTYPE | The data type to use for adding elements to the collection class object. |
CHeapPtrElementTraits::OUTARGTYPE | The data type to use for retrieving elements from the collection class object. |
Remarks
This class provides methods, static functions, and typedefs for aiding the creation of collection class objects containing heap pointers. The class CHeapPtrList
derives from CHeapPtrElementTraits
.
For more information, see ATL Collection Classes.
Inheritance Hierarchy
CHeapPtrElementTraits
Requirements
Header: atlcoll.h
CHeapPtrElementTraits::INARGTYPE
The data type to use for adding elements to the collection class object.
typedef CHeapPtr<T, Allocator>& INARGTYPE;
CHeapPtrElementTraits::OUTARGTYPE
The data type to use for retrieving elements from the collection class object.
typedef T *& OUTARGTYPE;
See Also
CDefaultElementTraits Class
CComHeapPtr Class
Class Overview