Edit

Share via


CMapStringToPtr Class

Supports maps of void pointers keyed by CString objects.

Syntax

class CMapStringToPtr : public CObject

Members

The member functions of CMapStringToPtr are similar to the member functions of class CMapStringToOb. Because of this similarity, you can use the CMapStringToOb reference documentation for member function specifics. Wherever you see a CObject pointer as a function parameter or return value, substitute a pointer to void.

BOOL CMapStringToPtr::Lookup( LPCTSTR <key>, void*& <rValue> ) const;

for example, translates to

BOOL CMapStringToOb::Lookup( const char* <key>, CObject*& <rValue> ) const;

Public Constructors

Name Description
CMapStringToPtr::CMapStringToPtr Constructor.

Public Methods

Name Description
CMapStringToPtr::GetCount Returns the number of elements in this map.
CMapStringToPtr::GetHashTableSize Determines the current number of elements in the hash table.
CMapStringToPtr::GetNextAssoc Gets the next element for iterating.
CMapStringToPtr::GetSize Returns the number of elements in this map.
CMapStringToPtr::GetStartPosition Returns the position of the first element.
CMapStringToPtr::HashKey Calculates the hash value of a specified key.
CMapStringToPtr::InitHashTable Initializes the hash table.
CMapStringToPtr::IsEmpty Tests for the empty-map condition (no elements).
CMapStringToPtr::Lookup Looks up a void pointer based on the void pointer key. The pointer value, not the entity it points to, is used for the key comparison.
CMapStringToPtr::LookupKey Returns a reference to the key associated with the specified key value.
CMapStringToPtr::RemoveAll Removes all the elements from this map.
CMapStringToPtr::RemoveKey Removes an element specified by a key.
CMapStringToPtr::SetAt Inserts an element into the map; replaces an existing element if a matching key is found.

Public Operators

Name Description
CMapStringToPtr::operator [ ] Inserts an element into the map — operator substitution for SetAt.

Remarks

CMapStringToPtr incorporates the IMPLEMENT_DYNAMIC macro to support run-time type access and dumping to a CDumpContext object. If you need a dump of individual map elements, you must set the depth of the dump context to 1 or greater.

String-to-pointer maps may not be serialized.

When a CMapStringToPtr object is deleted, or when its elements are removed, the CString key objects and the words are removed.

Inheritance Hierarchy

CObject

CMapStringToPtr

Requirements

Header: afxcoll.h

See also

CObject Class
Hierarchy Chart