CMapWordToPtr 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 CMapWordToPtr Class.
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 CMapStringToOb::Lookup( const char* <key>,
CObject*& <rValue> ) const;
for example, translates to
BOOL CMapWordToPtr::Lookup( WORD <key>, void*& <rValue> ) const;
Public Constructors
| Name | Description |
|---|---|
| CMapStringToOb::CMapStringToOb | Constructor. |
Public Methods
| Name | Description |
|---|---|
| CMapStringToOb::GetCount | Returns the number of elements in this map. |
| CMapStringToOb::GetHashTableSize | Determines the current number of elements in the hash table. |
| CMapStringToOb::GetNextAssoc | Gets the next element for iterating. |
| CMapStringToOb::GetSize | Returns the number of elements in this map. |
| CMapStringToOb::GetStartPosition | Returns the position of the first element. |
| CMapStringToOb::HashKey | Calculates the hash value of a specified key. |
| CMapStringToOb::InitHashTable | Initializes the hash table. |
| CMapStringToOb::IsEmpty | Tests for the empty-map condition (no elements). |
| CMapStringToOb::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. |
| CMapStringToOb::LookupKey | Returns a reference to the key associated with the specified key value. |
| CMapStringToOb::RemoveAll | Removes all the elements from this map. |
| CMapStringToOb::RemoveKey | Removes an element specified by a key. |
| CMapStringToOb::SetAt | Inserts an element into the map; replaces an existing element if a matching key is found. |
Public Operators
| Name | Description |
|---|---|
| CMapStringToOb::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
CMapWordToPtr
Requirements
Header: afxcoll.h