CMapWordToPtr Class

Article
08/03/2021

Supports maps of void pointers keyed by 16-bit words.

Syntax

class CMapWordToPtr : public CObject

Members

The member functions of CMapWordToPtr 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. Wherever you see a CString or a const pointer to char as a function parameter or return value, substitute WORD.

BOOL CMapWordToPtr::Lookup( WORD <key>, void*& <rValue> ) const;

for example, translates to

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

Public Constructors

Name	Description
CMapWordToPtr::CMapWordToPtr	Constructor.

Public Methods

Name	Description
CMapWordToPtr::GetCount	Returns the number of elements in this map.
CMapWordToPtr::GetHashTableSize	Determines the current number of elements in the hash table.
CMapWordToPtr::GetNextAssoc	Gets the next element for iterating.
CMapWordToPtr::GetSize	Returns the number of elements in this map.
CMapWordToPtr::GetStartPosition	Returns the position of the first element.
CMapWordToPtr::HashKey	Calculates the hash value of a specified key.
CMapWordToPtr::InitHashTable	Initializes the hash table.
CMapWordToPtr::IsEmpty	Tests for the empty-map condition (no elements).
CMapWordToPtr::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.
CMapWordToPtr::LookupKey	Returns a reference to the key associated with the specified key value.
CMapWordToPtr::RemoveAll	Removes all the elements from this map.
CMapWordToPtr::RemoveKey	Removes an element specified by a key.
CMapWordToPtr::SetAt	Inserts an element into the map; replaces an existing element if a matching key is found.

Public Operators

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

Remarks

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

Word-to-pointer maps may not be serialized.

When a CMapWordToPtr object is deleted, or when its elements are removed, the words and the pointers are removed. The entities referenced by the pointers are not removed.

For more information on CMapWordToPtr, see the article Collections.

Inheritance Hierarchy

CObject

CMapWordToPtr

Requirements

Header: afxcoll.h