Important Notice

The pages on this site contain documentation for very old MS-DOS software, purely for historical purposes. If you're looking for up-to-date documentation, particularly for programming, you should not rely on the information found here, as it will be woefully out of date.

◄CObject►                                     ◄Up► ◄Contents► ◄Index► ◄Back►
──Microsoft Foundation Classes──────────────────────────────────────────────
 
  Description
 
  The CMapWordToPtr class supports maps of void pointers keyed by 16-bit
  words.
 
  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;
 
  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.
 
  #include <afxcoll.h>
 
  Public Members
 
  Construction/Destruction
 
  ◄CMapWordToPtr►   Constructs a collection that maps words to void
                    pointers.
 
  ◄~CMapWordToPtr►   Destroys a CMapWordToPtr object.
 
  Operations
 
  ◄Lookup►             Returns a void pointer, using a word value as a
                       key.
 
  ◄SetAt►              Inserts an element into the map; replaces an
                       existing element if a matching key is found.
 
  ◄operator []►        Inserts an element into the map──operator
                       substitution for SetAt.
 
  ◄RemoveKey►          Removes an element specified by a key.
 
  ◄RemoveAll►          Removes all the elements from this map.
 
  ◄GetStartPosition►   Returns the position of the first element.
 
  ◄GetNextAssoc►       Gets the next element for iterating.
 
  Status
 
  ◄GetCount►   Returns the number of elements in this map.
 
  ◄IsEmpty►    Tests for the empty-map condition (no elements).
 
 
                                     -♦-