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.

class CMapWordToPtr : public CObject  

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

NameDescription
CMapStringToOb::CMapStringToObConstructor.

Public Methods

NameDescription
CMapStringToOb::GetCountReturns the number of elements in this map.
CMapStringToOb::GetHashTableSizeDetermines the current number of elements in the hash table.
CMapStringToOb::GetNextAssocGets the next element for iterating.
CMapStringToOb::GetSizeReturns the number of elements in this map.
CMapStringToOb::GetStartPositionReturns the position of the first element.
CMapStringToOb::HashKeyCalculates the hash value of a specified key.
CMapStringToOb::InitHashTableInitializes the hash table.
CMapStringToOb::IsEmptyTests for the empty-map condition (no elements).
CMapStringToOb::LookupLooks 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::LookupKeyReturns a reference to the key associated with the specified key value.
CMapStringToOb::RemoveAllRemoves all the elements from this map.
CMapStringToOb::RemoveKeyRemoves an element specified by a key.
CMapStringToOb::SetAtInserts an element into the map; replaces an existing element if a matching key is found.

Public Operators

NameDescription
CMapStringToOb::operator [ ]Inserts an element into the map — operator substitution for SetAt.

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.

CObject

CMapWordToPtr

Header: afxcoll.h

CObject Class
Hierarchy Chart

Show: