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 CMapPtrToWord class supports maps of 16-bit words keyed by void
  pointers.
 
  The member functions of CMapPtrToWord 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 WORD. Wherever you see a CString or a const
  pointer to char as a function parameter or return value, substitute a
  pointer to void.
 
  BOOL CMapStringToOb::Lookup( const char* <key>,
                               CObject*& <rValue> ) const;
 
  for example, translates to
 
  BOOL CMapPtrToWord::Lookup( const void* <key>, WORD& <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.
 
  Pointer-to-word maps may not be serialized.
 
  When a CMapPtrToWord object is deleted, or when its elements are
  removed, the pointers and the words are removed. The entities referenced
  by the key pointers are not removed.
 
  #include <afxcoll.h>
 
  Public Members
 
  Construction/Destruction
 
  ◄CMapPtrToWord►   Constructs a collection that maps void pointers to
                    16-bit words.
 
  ◄~CMapPtrToWord►   Destroys a CMapPtrToWord object.
 
  Operations
 
  ◄Lookup►             Returns a WORD, using a void pointer as a key. The
                       pointer value is used for the key comparison, not
                       the entity it points to.
 
  ◄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).
 
 
                                     -♦-